Skip to content

API Designer

Drafts REST API endpoint specifications with headers, bodies, responses and error codes for a described system

Stars
49,023
Licence
MIT
Files
1 file

What it does

Once installed, the agent turns a plain-language description of a system (for example a booking site or e-commerce store) into a structured REST API design. It lists the endpoints, groups them by resource, and for each one shows the HTTP method, path, auth headers, example request and response bodies, and relevant error codes. It can also suggest security considerations such as authorization, rate limits and idempotency, and offers to produce API documentation afterwards. The skill is a set of written instructions only; it contains no scripts of its own.

Great for

  • Developers planning the endpoints for a new backend before writing code
  • Architects who want a consistent first draft of REST conventions, paths and error codes to review with a team
  • Students learning how REST APIs are typically structured

Skip it if

  • Production sign-off: the skill itself says endpoint lists are proposed designs, not proof of production readiness, so security and performance still need human review
  • Existing APIs that must match a real contract, since the agent infers resources and may miss or invent details without the actual system specification

Try asking

  • “Design an API for a hotel booking system with rooms, guests and payments”
  • “What endpoints do I need for a multi-vendor e-commerce marketplace?”
  • “Give me Endpoints Only for a task management app with teams and projects”
Step-by-step guide: how to use API DesignerInstall, 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-designer.zip
  2. 2

    Add it to your agent

    Claude Code (all projects)

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

    Claude Code / Agent SDK (this project only)

    mkdir -p .claude/skills && unzip api-designer.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

  • Describe your domain, main users and any third-party integrations up front so the agent skips the clarifying questions and infers better resources
  • Ask for Detail Design when you need full headers, bodies and error tables, and Endpoints Only for a quick overview
  • Treat the output as a starting draft and check auth, tenant isolation and rate limits against your own requirements

What's inside

  • SKILL.md

Redistributed unmodified from sickn33/agentic-awesome-skills 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.