API Design Patterns

38 pravidel pro pojmenování REST koncových bodů, chyby, stránkování, verzování a zabezpečení API.

od AsyrafHussin · AsyrafHussin/agent-skills

Otestováno · Funguje ★ 9.6/10

API Design Patterns — 38 pravidel pro pojmenování REST koncových bodů, chyby, stránkování, verzování a zabezpečení API.

Co umí

Zkrácená příručka pravidel (38 pravidel / 7 kategorií) pro návrh RESTful API, pokrývající pojmenování zdrojů, tvar chybových odpovědí, stránkování, verzování a autentizaci. Spouští se při navrhování nebo revizi koncových bodů, nebo při psaní kódu pro zpracování chyb/stránkování, a odkazuje na soubory pro jednotlivá pravidla (rules/*.md) a 7 200řádkový kompilovaný AGENTS.md pro hlubší ponory.

Testovací report

Provedl jsem skutečný redesign 'invoices API' skrze něj: dovednost změnila URL založené na slovesech (POST /createInvoice) na vlastní podstatná jména, nahradila holý chybový řetězec strukturovanou obálkou (code/message/details/request_id) a přidala metadata stránkování kurzorem plus HATEOAS odkazy, které naivní základní verze nikdy neměla.

Testováno: 2026-07-14 · Claude Code 2.x (agent harness)

Instalace

git clone https://github.com/AsyrafHussin/agent-skills
cd agent-skills
mkdir -p ~/.claude/skills
cp -r skills/api-design-patterns ~/.claude/skills/api-design-patterns

Příkazy a ukázkové prompty

  • /api-design-patterns38 pravidel pro pojmenování REST koncových bodů, chyby, stránkování, verzování a zabezpečení API.

Skilly se spouštějí běžnými požadavky — žádné příkazy k zapamatování. Po instalaci ho aktivují prompty jako tyto (anglicky):

  • Design a REST API for user management with proper error handling
  • Review my API endpoints for best practices before we ship
  • What HTTP status codes should I use for this validation error?