REST API Tervezési Alapelvek: Hogyan építsünk tiszta végpontokat?
A modern webes és mobilalkalmazások (mint például egy iOS app) és a szerverek közötti kommunikáció legelterjedtebb formája a REST (Representational State Transfer) architektúra. A REST API-k határozzák meg azokat a szabványokat és végpontokat, amelyeken keresztül adatokat cserélhetünk.
A tiszta és skálázható REST API tervezéséhez elengedhetetlen néhány alapvető szabály szigorú betartása:
1. Erőforrás-alapú URL struktúra
Az URL-eknek mindig főneveket (erőforrásokat) kell jelölniük, nem pedig igéket (akciókat). A többes szám használata javasolt.
| Rossz megközelítés (Ige) | Helyes megközelítés (Főnév + HTTP metódus) |
|---|---|
| POST /getUsers | GET /users |
| POST /createNewUser | POST /users |
| GET /deleteUser?id=5 | DELETE /users/5 |
2. A HTTP metódusok szemantikája
- GET: Erőforrások lekérése (biztonságos, nem módosíthat adatot).
- POST: Új erőforrás létrehozása.
- PUT: Létező erőforrás teljes frissítése.
- DELETE: Erőforrás törlése.
3. Megfelelő HTTP státuszkódok használata
A szervernek a válaszában mindig a valóságnak megfelelő kódot kell küldenie. Például sikeres létrehozás esetén 201 Created, hibás kliens kérés esetén 400 Bad Request, nem talált erőforrás esetén pedig a klasszikus 404 Not Found kódot.