Skip to content

Commit 4819018

Browse files
committed
readme update
1 parent 82b7fb5 commit 4819018

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

README.md

+47
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,51 @@ Run this command in the application directory to run the test suite, make sure A
2121
> make test
2222
```
2323

24+
## API
25+
26+
### Projects
27+
Get all projects
28+
```bash
29+
> http http://localhost:8080/projects
30+
```
31+
32+
Create a project
33+
```bash
34+
> http -f POST http://localhost:8080/projects name=test
35+
```
36+
37+
Edit the project
38+
```bash
39+
> http -f PUT http://localhost:8080/projects/1 name=test1
40+
```
41+
42+
Remove the project
43+
```bash
44+
> http DELETE http://localhost:8080/projects/1
45+
```
46+
47+
### Tasks
48+
Get all tasks
49+
```bash
50+
> http http://localhost:8080/tasks
51+
```
52+
53+
Create a task
54+
```bash
55+
> http -f POST http://localhost:8080/tasks name=test description=test-task project=1 'tag[]'=tag1 'tag[]'=tag2
56+
```
57+
58+
Edit the task
59+
```bash
60+
> http -f PUT http://localhost:8080/tasks/1 name=test1
61+
```
62+
63+
Remove the task
64+
```bash
65+
> http DELETE http://localhost:8080/tasks/1
66+
```
67+
68+
69+
> The **[http](https://httpie.org/)** tool
70+
2471
That's it!

0 commit comments

Comments
 (0)