Skip to content
Get packs

REST API Design Patterns

Design consistent REST APIs with standard naming, status codes, pagination, errors and versioning.

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

What it does

This skill gives an AI agent a set of conventions for designing web APIs (the way programs talk to each other over the internet). Once installed, the agent follows rules for naming URLs, choosing HTTP status codes, formatting responses and errors, paginating and filtering lists, handling authentication, setting rate limits, and versioning. It is a reference guide written in Japanese, and it does not run code or contact any service.

Great for

  • Backend developers designing a new REST API or endpoint
  • Teams reviewing an existing API contract for consistency
  • Developers building public or partner-facing APIs who want sensible defaults

Skip it if

  • Non-API work such as front-end styling or document writing, because the skill only covers REST API design
  • GraphQL or gRPC APIs, because the patterns are specific to REST and HTTP status codes
  • Production security decisions on their own, because the examples are general guidance and do not replace a security review of authentication and rate limiting

Try asking

  • “Design REST endpoints for a new orders service with pagination and filtering”
  • “Review this API contract and point out naming or status code mistakes”
  • “Suggest an error response format with field-level validation details”
  • “Compare offset and cursor pagination for a large user list”
Step-by-step guide: how to use REST API Design PatternsInstall, first run, examples, tips and FAQs

Install in 3 steps

  1. 1

    Download the skill

    The ZIP contains the 1 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

  • Ask for the reason behind a recommendation, such as why cursor pagination fits your data size, so you can judge the trade-off yourself.
  • Give the agent your existing endpoints or a sample response so it can check consistency with your current conventions.
  • The guide is written in Japanese; ask in Japanese or specify the language you want the output in.

What's inside

  • 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.