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

Move and adapt api documentation for fragen

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

123
backend/README.md
View file

@ -243,3 +243,126 @@ Content-Type: application/json
"name": "Digitales",
}
```
## Fragen
### Get all questions
#### Request
```
GET /fragen
```
#### Example Response
```
200 OK
Content-Type: application/json
```
```json
[
{
"id": 0,
"text": "Dies ist eine Dummy Frage für Testzwecke",
"kategorie": "Umwelt"
},
{
"id": 1,
"text": "Eine weitere Testfrage",
"kategorie": "Soziales"
}
]
```
### Get the question with id `<id>` (not implemented yet)
#### Request
```
GET /fragen/<id>
```
#### Example Response
```
200 OK
Content-Type: application/json
```
```json
{
"id": 1,
"text": "Eine weitere Testfrage",
"kategorie": "Soziales"
}
```
### Get questions filtered by category (not implemented yet)
#### Request
```
GET /fragen?kategorie=Umwelt
```
#### Example Response
```
200 OK
Content-Type: application/json
```
```json
[
{
"id": 0,
"text": "Dies ist eine Dummy Frage für Testzwecke",
"kategorie": "Umwelt"
}
]
```
### Create a new question (not implemented yet)
#### Request
```
POST /fragen
Content-Type: application/json
```
```json
{
"text": "Dies ist noch eine Dummy Frage für Testzwecke",
"kategorie": "Umwelt"
}
```
If the value for the key `"kategorie"` does not exist yet it will be created on-the-fly.
#### Example Response
```
201 OK
Content-Type: application/json
```
```json
{
"id": 2,
"text": "Dies ist noch eine Dummy Frage für Testzwecke",
"kategorie": "Umwelt"
}
```
### Alter the question with id `<id>` (not implemented yet)
#### Request
```
PUT /fragen/<id>
Content-Type: application/json
```
```json
{
"text": "Dies ist eine geaenderte Dummy Frage",
"kategorie": "Digitales"
}
```
#### Example Response
```
200 OK
Content-Type: application/json
```
```json
{
"id": 2,
"text": "Dies ist eine geaenderte Dummy Frage",
"kategorie": "Digitales"
}
```
Like for creating a new question, if the value for the key `"kategorie"` does not exist yet,
it will be created on the fly.