Created
September 5, 2014 09:18
-
-
Save aBuder/45af7c73d75864d96a3e to your computer and use it in GitHub Desktop.
Beschreibung der Rest API für gemeinsames SPA Projekt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Die Rest Api sollte 'todo' Objekte ausliefern, erzeugen und ändern. Ein 'todo' Objekt hat folgende Struktur.```` | |
{ | |
'id': int | long | text | |
'name': text, | |
'done': false | true, | |
'created' long | |
} | |
Die Bedeutung der folgenden Felder ist wie folgt: | |
'id' -> eindeutige ID des todo's, hier sollte als Datentyp ein Integer, Long, oder String gewählt werden | |
'name' -> Beschreibung des todo, erfolgt als text | |
'done' -> Status beschreibt ob ein todo erledigt wurde oder nicht true bei erledigt und false bei unerledigt | |
'created' -> Zeitstempel als unix timestamp in millisekunden, beschreibt das Datum wann das todo Objekt erstellt wurde | |
Ein Beispiel 'todo' könnte demnach wie folgt aussehen: | |
{ | |
'id': 12 | |
'name': 'Im Wohnzimmer Staub saugen', | |
'done': false, | |
'created' 1409907690 | |
} | |
Für das Rest Backend werden die nachfolgenden Ressourcen benötigt, die Format für die Datenübermittlung wird Json verwendet. | |
GET /todos -> Liefert ein Json Array mit allen 'todo' Objekten | |
Bsp: | |
Request: | |
GET /todos | |
Response: | |
[ | |
{ | |
'id': 12 | |
'name': 'Im Wohnzimmer Staub saugen', | |
'done': false, | |
'created' 1409907690 | |
}, | |
{ | |
'id': 13 | |
'name': 'Blumen gießen', | |
'done': true, | |
'created' 140990887 | |
}, | |
{ | |
'id': 14 | |
'name': 'Geschirr abwaschen', | |
'done': false, | |
'created' 140990882 | |
} | |
] | |
GET /todos/:id -> leifert ein 'todo' Objekt :id beschreibt die eindeutige ID des todo Objektes | |
Bsp: | |
Request: | |
GET /todos/14 | |
Response: | |
{ | |
'id': 14 | |
'name': 'Geschirr abwaschen', | |
'done': false, | |
'created' 140990882 | |
} | |
PUT /todos/:id -> aktualiseirt ein 'todo' Objekt :id beschreibt die eindeutige ID des todo Objektes | |
Bsp: | |
Request: | |
PUT /todos/14 | |
Body: | |
{ | |
'name': 'Fenster putzen', | |
'done': true, | |
'created' 140990882 | |
} | |
Response: | |
{ | |
'id': 14 | |
'name': 'Fenster putzen', | |
'done': true, | |
'created' 140990882 | |
} | |
DELETE /todos/:id -> löscht ein 'todo' Objekt :id beschreibt die eindeutige ID des todo Objektes | |
Bsp: | |
Request: | |
DELETE /todos/14 | |
Body: | |
Response: | |
200 OK | |
POST /todos -> legt ein neues 'todo' Objekt an | |
Bsp: | |
Request: | |
Post /todos | |
Body: | |
{ | |
'name': 'Betten beziehen', | |
'done': false, | |
'created' 140990742 | |
} | |
Response: | |
{ | |
'id': 15 | |
'name': 'Betten beziehen', | |
'done': false, | |
'created' 140990742 | |
} | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment