HTTP-protokollet definierar ett antal metoder som tilldelar en begäran semantisk betydelse. Vi har valt att använda följande i TW API 3
•GET hämtar en återgivning av resursen från angiven URI. Innehållet i svarsmeddelandet innehåller information om den begärda resursen.
•POST skapar en ny resurs på angiven URI. Innehållet i begärandemeddelandet innehåller information om den nya resursen. Observera att POST kan också användas till att utlösa åtgärder som inte konkret skapar resurser.
•PUT skapar eller ersätter resursen på angiven URI. Innehållet i begärandemeddelandet anger den resurs som ska skapas eller uppdateras.
•DELETE tar bort resursen på angiven URI.
Effekten av en specifik begäran bör bero på om resursen är en samling eller ett enskilt objekt. I följande tabell sammanfattas de gemensamma konventioner som har använts av de flesta RESTful-implementeringarna.
|
Resurs |
POST |
GET |
PUT |
DELETE |
|
/clients |
Skapa en ny kund |
Hämta alla kunder |
Massuppdatering av kunder |
Ta bort alla kunder |
|
/clients/1 |
|
Hämta informationen för kund 1 |
Uppdatera informationen om kund 1, om sådan finns |
Ta bort kund 1 |
GET-metoder
En lyckad GET-metod returnerar HTTP-statuskod 200 (OK). Om det inte går att hitta resursen ska metoden returnera 404 (hittades ej).
POST-metoder
Om en POST-metod skapar en ny resurs returnerar den HTTP-statuskod 201 (skapad). URI för den nya resursen ingår i svarets platsrubrik. Svarstexten innehåller en återgivning av resursen.
Om metoden utför viss bearbetning, men inte skapar en ny resurs, returnerar metoden HTTP-statuskod 200 och inkluderar resultatet av åtgärden i svarstexten. Om det inte finns några resultat som ska returneras kan metoden alternativt returnera HTTP-statuskod 204 (inget innehåll) utan någon svarstext.
Om klienten placerar ogiltiga data i begäran ska servern returnera HTTP-statuskod: 400 (felaktig begäran). Svarstexten kan innehålla ytterligare information om felet eller en länk till en URI som innehåller mer information.
PUT-metoder
Metoden uppdaterar en befintlig resurs och returnerar antingen 200 (OK) eller 204 (inget innehåll). I vissa fall kanske det inte går att uppdatera en befintlig resurs. I så fall returneras HTTP-statuskod 409 (konflikt).
DELETE-metoder
Om borttagningen lyckas svarar den med HTTP-statuskod 204, som anger att processen har hanterats, men att svarstexten inte innehåller någon ytterligare information. Om resursen inte finns retunerar webbservern HTTP 404 (kunde inte hittas).