Junior — Middle
Hogyan lehet megállapítani, hogy egy API megfelel-e a RESTful architektúra elveinek?
sobes.tech MI
Válasz az MI-től
A RESTful API megfelel a REST alapelveinek, ha a következő kulcsfontosságú kritériumokat teljesíti:
- A HTTP-módszerek helyes használata: GET az adatok lekéréséhez, POST az adatok létrehozásához, PUT/PATCH a frissítéshez, DELETE a törléshez.
- Az erőforrások URI-val való azonosítása: minden erőforrásnak egyedi és érthető URL-je van.
- Állapot nélküli működés (stateless): minden kérés tartalmazza a szükséges összes információt, a szerver nem tartja nyilván a kliens állapotát.
- A HTTP-válasz kódok szabványos használata: például 200 OK, 404 Not Found, 201 Created.
- Különböző reprezentációs formátumok támogatása (pl. JSON, XML) az Accept/Content-Type fejlécen keresztül.
Ezt az API megfelelőségének elemzésével és a HTTP helyes használatának ellenőrzésével lehet megtenni.
Példa:
GET /users/123 HTTP/1.1
Host: example.com
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{"id":123, "name":"Ivan"}