Skip to content
Get packs

API Design Patterns

Guides the agent to design and review REST APIs with consistent naming, status codes, pagination and versioning.

Source Download skill
Repository
affaan-m/ECC
Stars
295,127
Licence
MIT
Files
2 files

What it does

When you ask the agent to design or review a web API (the way apps talk to a server), this skill makes it follow a consistent set of conventions. It covers how to name endpoints (plural nouns, kebab-case), which HTTP status codes to return, how to structure success and error responses, how to paginate, filter and sort results, and how to version and rate-limit an API. The agent then checks your design against these rules and suggests fixes.

Great for

  • Backend developers designing new REST endpoints
  • Teams reviewing existing API contracts before release
  • Anyone building a public or partner-facing API who wants consistent conventions

Skip it if

  • Non-REST styles such as GraphQL or gRPC, which the skill does not address (its guidance is REST-specific)
  • Teams with an established internal API standard, since the skill's conventions may conflict with it and the agent could push the wrong defaults

Try asking

  • “Review these endpoints for REST naming and status code problems: GET /api/getUsers, POST /api/user/create”
  • “Design a paginated orders endpoint with filtering by status and date range”
  • “Suggest an error response format with field-level validation details for my signup API”
  • “Plan a versioning strategy for a public partner API that already has v1 clients”
Step-by-step guide: how to use API Design PatternsInstall, first run, examples, tips and FAQs

Install in 3 steps

  1. 1

    Download the skill

    The ZIP contains the 2 original files, the MIT licence and an attribution note.

    api-design.zip
  2. 2

    Add it to your agent

    Claude Code (all projects)

    mkdir -p ~/.claude/skills && unzip api-design.zip -d ~/.claude/skills/

    Claude Code / Agent SDK (this project only)

    mkdir -p .claude/skills && unzip api-design.zip -d .claude/skills/

    Claude apps (web/desktop): Settings → Capabilities → Skills → Upload skill, and choose the ZIP.

  3. 3

    Ask for the task

    No special command needed — the agent reads the skill's description and loads it when your request matches. Try one of the prompts above.

Get better results

  • Give the agent your actual endpoint list or OpenAPI spec so it reviews real contracts rather than generic examples.
  • Mention your constraints (public vs internal API, expected data size) because the skill's pagination advice depends on them.
  • Treat the output as guidance to check against your own standards; the skill's examples are opinionated and not a formal specification.

What's inside

  • agents/openai.yaml
  • SKILL.md

Redistributed unmodified from affaan-m/ECC under the MIT licence. The assessment was drafted with AI from the skill's files on 2026-10-29. Skills can instruct your agent to run code — read SKILL.md and any scripts before installing.