Mi az API és mit jelent a REST?
API és REST közérthetően: erőforrások, endpointok, HTTP metódusok, státuszkódok és stabil szerződés frontend és backend között.
Röviden
Az API egy programozható interfész két komponens között. Web API esetén ez gyakran HTTP-n elérhető szerződés: milyen erőforrást, milyen metódussal, milyen adattal lehet kérni, és milyen választ kapsz.
Mit jelent a mi az api és mit jelent a rest??
Az API egy programozható interfész két komponens között. Web API esetén ez gyakran HTTP-n elérhető szerződés: milyen erőforrást, milyen metódussal, milyen adattal lehet kérni, és milyen választ kapsz.
A lényeg vizuálisan
01
GET olvasásra és lehetőség szerint safe műveletre való.
02
POST tipikusan új művelet/erőforrás indítása.
03
PUT teljes cseréhez, PATCH részleges módosításhoz használható.
04
Státuszkód és hiba body együtt ad gépileg kezelhető szerződést.
Hogyan működik a gyakorlatban?
A REST egy architekturális stílus, nem kötelező JSON URL-formátum. A gyakorlatban erőforrás-központú URL-ekkel, HTTP szemantikával, stateless kérésekkel és cache-elhetőséggel találkozol. Ettől még egy jó API lehet részben REST-szerű anélkül, hogy tankönyvi tisztaságra törekedne.
- GET olvasásra és lehetőség szerint safe műveletre való.
- POST tipikusan új művelet/erőforrás indítása.
- PUT teljes cseréhez, PATCH részleges módosításhoz használható.
- Státuszkód és hiba body együtt ad gépileg kezelhető szerződést.
Egyszerű erőforrás API
HTTP
GET /api/projects/42
200 OK
PATCH /api/projects/42
{ "name": "Pulse" }
200 OKGyakorlati fejlesztői szemlélet
API névadásnál stabil üzleti erőforrásokra építs, ne a jelenlegi UI gombjaira. Egy `/projects/:id/members` szerződés több kliensből is értelmezhető, míg egy `/handleInviteModalSubmit` a frontend implementációját szivárogtatja ki.
Gyakori hibák és félreértések
- Minden hibára 200 státuszt visszaadni `success:false` bodyval.
- GET-tel adatot módosítani.
- Endpointokat frontend komponensnevekhez kötni.
Források és szabványok
A technikai részletekhez elsődleges szabványokat és karbantartott hivatalos dokumentációt használok. Frameworkök, böngészők és webes API-k idővel változhatnak, ezért implementálás előtt mindig ellenőrizd az aktuális dokumentációt is.
Kapcsolódó ByBence Academy