Ukázkové schéma základního REST API – tahák pro každého vývojáře

Při návrhu REST API se hodí mít po ruce jednoduchý přehled základních principů a endpointů. Následující ukázka slouží jako „tahák“, který ukazuje, jak mohou vypadat typické zdroje (entities), jejich operace a doporučené postupy. Navazující příspevek na https://www.lukashron.cz/jak-spravne-predavat-data-v-rest-api.html.

Entita: Article

GET /api/articles → seznam článků  
POST /api/articles → vytvoření článku  
GET /api/articles/{id} → detail článku  
PUT /api/articles/{id} → update celého článku  
PATCH /api/articles/{id} → částečná změna článku  
DELETE /api/articles/{id} → smazání článku  

Entita: Comment

GET /api/comments → seznam všech komentářů  
POST /api/comments → vytvoření komentáře  
GET /api/comments/{id} → detail komentáře  
PUT /api/comments/{id} → update komentáře  
DELETE /api/comments/{id} → smazání komentáře  

Nested resources

Vnořené zdroje se hodí tam, kde jedna entita logicky patří k jiné. V našem případě jsou to komentáře přiřazené článku:

POST /api/articles/{articleId}/comments/{commentId} → přiřadit existující komentář k článku  
DELETE /api/articles/{articleId}/comments/{commentId} → odpojit komentář od článku  

Akční endpointy (noREST, ale praktické)

REST se snaží držet jednotné struktury, ale v praxi se často hodí i „akční“ endpointy. Ty sice nespadají do čistého REST standardu, ale zvyšují čitelnost a jednoduchost API:

POST /api/articles/{id}/publish → publikovat článek  
POST /api/articles/{id}/unpublish → stáhnout článek  

Obecná doporučení

• Používat množné číslo pro názvy zdrojů (/articles, /comments).
• Verzovat API od začátku – např. /v1/articles/… – předejdeš tím budoucím problémům s kompatibilitou.
• Konzistence je klíčová – drž se jednotného stylu napříč celým API.