NB-Public/kandimat
13
0
Fork 0
Code Issues 15 Pull requests Projects Releases 1 Wiki Activity

Move and adapt api documentation for kategorien

Browse source
This commit is contained in:
Christoph Lienhard 2019-09-20 16:15:23 +02:00
parent fdff6b3013
commit c7d81ccb3a
1 changed files with 68 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

68
backend/README.md
View file

@ -175,3 +175,71 @@ Content-Type: application/json
"email": "kind.mustermann@gmx.com"
}
```
## Kategorien
### Get all categories
#### Request
```
GET /kategorien
```
#### Example Response
```
200 OK
Content-Type: application/json
```
```json
[
{
"id": 0,
"name": "Umwelt"
},
{
"id": 1,
"name": "Soziales"
}
]
```
### Get the category with id `<id>` (not implemented yet)
#### Request
```
GET /kategorien/<id>
```
#### Example Response
```
200 OK
Content-Type: application/json
```
```json
{
"id": 0,
"name": "Umwelt",
}
```
### Create a new category (not implemented yet)
#### Request
```
POST /kategorien
Content-Type: application/json
```
```json
{
"name": "Digitales",
}
```
#### Example Response
```
201 OK
Content-Type: application/json
```
```json
{
"id": 2,
"name": "Digitales",
}
```