API design checklist

Dobrý API design šetří čas všem. Projděte tento checklist před publikací API.

Naming & Structure

• ☐ Resourcey jako podstatná jména (/users, /orders)
• ☐ Plural konzistentně
• ☐ Hierarchické URL (/users/123/orders)
• ☐ Kebab-case pro multi-word
• ☐ Versioning (v1/users nebo Accept header)

HTTP metody

• ☐ GET = čtení (idempotentní)
• ☐ POST = vytvoření
• ☐ PUT = celý update
• ☐ PATCH = částečný update
• ☐ DELETE = smazání

Response

• ☐ Konzistentní response format
• ☐ Správné status codes
• ☐ Pagination (limit/offset nebo cursor)
• ☐ Filtering a sorting parametry
• ☐ HATEOAS links (volitelné)

Error handling

• ☐ Strukturované error response { code, message, details }
• ☐ Validační chyby s field-level detaily
• ☐ Žádné stack traces v produkci
• ☐ Rate limit headers (X-RateLimit-*)

Bezpečnost

• ☐ Authentication (Bearer token / API key)
• ☐ Authorization na každém endpointu
• ☐ Input validace a sanitizace
• ☐ CORS správně nakonfigurovaný
• ☐ Rate limiting

Dokumentace

• ☐ OpenAPI/Swagger spec
• ☐ Příklady pro každý endpoint
• ☐ Error catalog
• ☐ Getting started guide