REST API » Historie » Revize 6
Revize 5 (Jiří Trefil, 2023-03-15 22:47) → Revize 6/7 (Jiří Trefil, 2023-03-15 22:53)
h1. Co je REST API konvence?
* REST API konvence jsou souborem pravidel, doporučení a osvědčených postupů pro návrh a implementaci RESTful API.
* 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).
h2. Klíčová pravidla
* Použití pouze *standardních HTTP metod* (GET, POST, PUT, DELETE) pro vyjádření akce na zdrojích. Například:
> * GET metodou žádám o informace o nějakém uživateli
> * POST metodou odesílám data o uživateli, kterého chci založit.
> > * 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)
> * DELETE pro smazání uživatele
* Použití datového formtáu *JSON* pro výměnu dat.
* 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)
* Bezestavovost API - neudržovat na serveru stav klientské aplikace.