REST API » Historie » Verze 6
Jiří Trefil, 2023-03-15 22:53
| 1 | 2 | Jiří Trefil | h1. Co je REST API konvence? |
|---|---|---|---|
| 2 | |||
| 3 | 4 | Jiří Trefil | * REST API konvence jsou souborem pravidel, doporučení a osvědčených postupů pro návrh a implementaci RESTful API. |
| 4 | 5 | Jiří Trefil | * Dodržováním těchto konvencí získáme konzistenci, jednoduchost, snadnou čitelnost a případně interoperabilitu mezi systémy (vzájemně víme, jak komunikuje). |
| 5 | |||
| 6 | h2. Klíčová pravidla |
||
| 7 | |||
| 8 | * Použití pouze *standardních HTTP metod* (GET, POST, PUT, DELETE) pro vyjádření akce na zdrojích. Například: |
||
| 9 | > * GET metodou žádám o informace o nějakém uživateli |
||
| 10 | > * POST metodou odesílám data o uživateli, kterého chci založit. |
||
| 11 | > > * na toto je možné použít i PUT, který je designovaný tak, aby byl request idempotentní (můžu request poslat klidně 100x, ale výsledek se mi vrátí jako kdybych jej poslal právě 1x) |
||
| 12 | > * DELETE pro smazání uživatele |
||
| 13 | 6 | Jiří Trefil | |
| 14 | * Použití datového formtáu *JSON* pro výměnu dat. |
||
| 15 | * Používat *vhodné HTTP kódy odpovědi* (10x - informace, 20x - úspěch operace, 30x - přesměrování, 40x - chyba klientského požadavku, 50x - chyba na straně serveru) |
||
| 16 | * Bezestavovost API - neudržovat na serveru stav klientské aplikace. |