Zum Inhalt springen
Kitbay
Skill

api-design

MITAktualisiert am 9. Nov. 2026300.529GitHub-Sterne

A reference skill from the ECC collection for designing or reviewing REST APIs.

Was der Skill vermittelt

A reference skill from the ECC collection for designing or reviewing REST APIs. It covers naming resources as plural, lowercase nouns, which HTTP methods are safe or idempotent, which status codes to return, and the shape of single, list and error responses. It compares offset and cursor pagination, shows filtering, sorting, search and sparse field selection, and covers bearer tokens and API keys, ownership and role checks, rate-limit headers and versioning in the URL path with a deprecation policy. Example handlers are given in TypeScript, Python and Go, and it ends with a checklist to go through before an API ships.

Funktionen

  • Name REST resources and choose HTTP methods and status codes
  • Design pagination, filtering and sorting
  • Plan rate limiting and API versioning
  • Check an API against a pre-release list