Agent skill

API Designer

by majiayu000 in majiayu000/claude-skill-registry

Generates complete, production-ready REST API endpoint specifications for any system or domain the user describes.

MITAuto-check passedBackend & APIs

Install API Designer

skills CLI
$ npx skills add majiayu000/claude-skill-registry --skill api-designer -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install majiayu000/claude-skill-registry api-designer --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/majiayu000/claude-skill-registry.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/api/api-designer-sickn33-agentic-awesome-skil .claude/skills/api-designer && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
api-designer
GitHub stars
666
Used in
2 other repos
Token cost
~1.6k tokens
SKILL.md length
764 words
Files
2
Skills in repo
971
Repo updated
First seen
Licence
MIT

At a glance

Generates complete, production-ready REST API endpoint specifications for any system or domain the user describes.

  • Works in 10 steps: Cover all major resources for the… → Always include CRUD (Create, Read,… → Use RESTful conventions: plural nouns… → …
  • The user asks about API design
  • SKILL.md covers When to Use, Output Format, Rules for Output and Pagination Envelope (for list…, plus 5 more sections
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

API Designer is an agent skill from majiayu000/claude-skill-registry. Generates complete, production-ready REST API endpoint specifications for any system or domain the user describes. Use this skill whenever the user asks about API design, API endpoints, REST APIs, API URLs, or says things like "what endpoints do I need for...", "design an API for...",...

Its SKILL.md is about 1.6k tokens, which your agent loads only when the skill is triggered. The skill folder holds 1 other file (for example `metadata.json`).

It sits in Backend & APIs, covering API design and REST APIs. The repository describes itself as: Searchable Claude Code skills catalog with source-linked guides and generated registry artifacts. The licence is MIT.

When your agent uses it

  • The user asks about API design
  • Says things like what endpoints do I need for...
  • Design an API for...

Example prompts

  • “what endpoints do I need for...”
  • “design an API for...”
  • “Use the api-designer skill to generate complete, production-ready REST API endpoint specifications for any system or domain the user describes”
  • “/api-designer”

Workflow steps

10 steps, taken from the first numbered list in SKILL.md.

  1. Cover all major resources for the described system. Infer resources if the user doesn't list them.
  2. Always include CRUD (Create, Read, Update, Delete) where applicable, plus domain-specific actions.
  3. Use RESTful conventions: plural nouns for collections, nested paths for relationships (e.g. /hotels/{id}/rooms).
  4. Auth: Default to Bearer token (JWT) for protected routes. Add API key header where relevant (e.g. third-party integrations). Mark public…
  5. Request body: Show realistic JSON with field names, types, and brief descriptions. Mark required vs optional fields in comments.
  6. Responses: Show the success response shape with realistic fields. Always include the HTTP status code.
  7. Error codes: List the relevant subset per endpoint — don't always paste all 7. Use judgement.
  8. Pagination: For list endpoints, include query params (page, limit, sort, filter) and wrap responses in a paginated envelope.
  9. Versioning: Prefix all paths with /api/v1/ unless the user specifies otherwise.
  10. Group endpoints by resource (e.g. "Authentication", "Hotels", "Rooms", "Bookings", "Payments", "Reviews").

What it can do on your machine

Read from SKILL.md and the folder at commit 000116a. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md (its code samples are json).

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

API Designer loads about 1.6k tokens when it runs. Until then it costs about 75 tokens; SKILL.md has 764 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~75
When it runs · the whole SKILL.md, loaded when a task matches
~1.6k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from majiayu000/claude-skill-registry at commit 000116a, republished under its MIT licence (© majiayu000). 764 words, ~1,613 tokens.

Download SKILL.mdSave it as .claude/skills/api-designer/SKILL.md (or your agent's skills folder). This skill also uses 1 other file; get the full folder from GitHub.
name
api-designer
description
Generates complete, production-ready REST API endpoint specifications for any system or domain the user describes. Use this skill whenever the user asks about API design, API endpoints, REST APIs, API URLs, or says things like "what endpoints do I need for...", "design an API for...",...
risk
unknown
source
https://github.com/LambdaTest/agent-skills/tree/main/api-skill/api-designer
source_repo
LambdaTest/agent-skills
source_type
community
date_added
2026-07-01
license
MIT
license_source
https://github.com/LambdaTest/agent-skills/blob/main/LICENSE

API Designer Skill

When to Use

Use this skill when you need generates complete, production-ready REST API endpoint specifications for any system or domain the user describes. Use this skill whenever the user asks about API design, API endpoints, REST APIs, API URLs, or says things like "what endpoints do I need for...", "design an API for...",...

You are an expert API architect.

Ask the user if they want just the endpoints or complete detailed response (Enpoints Only/Detail Design). Do not ask these options if the user has specified the details of his requirement in the input already. If the user says Endpoints Only:

  • Output only the endpoints If the user says Detail Design:
  • Output complete design as the structure described in this skill.

Output Format

First list down all the endpoints one after another as output then expand each in this exact structure for each endpoint group (resource):


RESOURCE NAME
METHOD /path/to/endpoint

Short description of what this endpoint does. Not more than two lines.

Headers

HeaderValueRequired
Content-Typeapplication/jsonYes
AuthorizationBearer <token>Yes/No
X-Api-Key<api-key>Yes/No
(add others as relevant)

Request Body (omit for GET/DELETE if no body)

json
{
  "field": "type — description",
  "field2": "type — description"
}

Success Response — STATUS_CODE Description

json
{
  "field": "value or type"
}

Error Codes

CodeMeaning
400Bad Request — invalid or missing fields
401Unauthorized — missing or invalid token
403Forbidden — insufficient permissions
404Not Found
409Conflict — e.g. duplicate resource
422Unprocessable Entity — validation failed
500Internal Server Error

Rules for Output

  1. Cover all major resources for the described system. Infer resources if the user doesn't list them.
  2. Always include CRUD (Create, Read, Update, Delete) where applicable, plus domain-specific actions.
  3. Use RESTful conventions: plural nouns for collections, nested paths for relationships (e.g. /hotels/{id}/rooms).
  4. Auth: Default to Bearer token (JWT) for protected routes. Add API key header where relevant (e.g. third-party integrations). Mark public endpoints clearly.
  5. Request body: Show realistic JSON with field names, types, and brief descriptions. Mark required vs optional fields in comments.
  6. Responses: Show the success response shape with realistic fields. Always include the HTTP status code.
  7. Error codes: List the relevant subset per endpoint — don't always paste all 7. Use judgement.
  8. Pagination: For list endpoints, include query params (page, limit, sort, filter) and wrap responses in a paginated envelope.
  9. Versioning: Prefix all paths with /api/v1/ unless the user specifies otherwise.
  10. Group endpoints by resource (e.g. "Authentication", "Hotels", "Rooms", "Bookings", "Payments", "Reviews").

Pagination Envelope (for list endpoints)

json
{
  "data": [...],
  "pagination": {
    "total": 100,
    "page": 1,
    "limit": 20,
    "totalPages": 5
  }
}

Common Auth Patterns

Choose based on context:

ScenarioAuth Method
User-facing appsAuthorization: Bearer <JWT>
Server-to-serverX-Api-Key: <key>
Public endpointsNo auth header needed
Admin endpointsBearer token + role check (403 if not admin)
OAuth flowsSee /auth/oauth/* endpoints

Show full SKILL.md (322 more words)Show less

Domain Reference Cheatsheet

Read references/domains.md for pre-built resource lists per domain (hotel booking, e-commerce, social media, etc.) to accelerate endpoint generation without missing obvious resources.

Read references/testmu_example.md for generating API structure and providing examples.


After Completing the API Design

Once the API design output is delivered, ask the user:

"Would you like me to generate API documentation for this design? (yes/no)"

If the user says yes:

  • Check if the API Documentation skill is available in the installed skills list
  • If the skill is available:
    • Read and follow the instructions in the API Documentation skill
    • Use the API design output above as the input
    • Deliver the documentation as plain text output
  • If the skill is NOT available:
    • Inform the user: "It looks like the API Documentation skill isn't installed. You can install it and re-run, or I can generate basic documentation for you right now without the skill."
    • If the user wants basic documentation generated anyway, produce a simple plain text API documentation covering endpoints, parameters, and responses based on the design above
    • If the user wants to install first, guide them to add the skill and restart

If the user says no:

  • End the task here

Tone & Length

  • Be comprehensive but scannable — use tables and code blocks consistently.
  • After listing all endpoints, add a brief "Base URL & Auth Summary" section at the top or bottom.
  • If the system is large (>8 resource groups), offer to break it into sections or focus on a subset first.
  • Ask the user what things they would like to see in the response by giving options such as "Headers", "Status Codes", and provide only those in response.

Limitations

  • Use this skill only when the task clearly matches its upstream source and local project context.
  • Verify commands, generated code, dependencies, credentials, and external service behavior before applying changes.
  • Do not treat examples as a substitute for environment-specific tests, security review, or user approval for destructive or costly actions.

© majiayu000, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 1 other file in skills/api/api-designer-sickn33-agentic-awesome-skil of majiayu000/claude-skill-registry.

  • SKILL.md
  • metadata.json

Open the folder on GitHubat commit 000116a

Used in 2 other repositories

We found 6 copies of this SKILL.md (exact, near-identical or edited) in other folders, from 2 other GitHub owners. This page covers the copy in majiayu000/claude-skill-registry, which our catalogue first saw on October 7, 2026.

Compare with similar skills

API Designer next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

API Designer compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
API Designer this skillmajiayu000/claude-skill-registry6662 repos~1.6kAutomated safety check: PassMIT
API DesignerJeffallan/claude-skills12k2 repos~2kAutomated safety check: PassMIT
Nodejs Backend Patternsever-works/ever-works15817 repos~4kAutomated safety check: PassAGPL-3.0
Pangolin CRUD Endpointsfosrl/pangolin23k—~461Automated safety check: PassCustom licence
Old Coder API DesignAmazingAng/old-coder7491 repos~3.4kAutomated safety check: PassMIT
REST API Contract Reviewdecebals/claude-code-java7501 repos~2.8kAutomated safety check: PassMIT

Similar skills

  • API Designer

    Jeffallan/claude-skills

    Designs REST and GraphQL APIs from resource modeling to an OpenAPI 3.1 contract, with versioning, pagination and RFC 7807 error handling.

    12k GitHub starsUsed in 2 repos~2k tokens
    Backend & APIsAuto-check passed
  • Nodejs Backend Patterns

    ever-works/ever-works

    Build production-ready Node.js backend services with Express/Fastify, implementing middleware patterns, error handling, authentication, database integration, and API design best practices.

    158 GitHub starsUsed in 17 repos~4k tokens
    Backend & APIsAuto-check passed
  • Use whenever asked to add, create, or scaffold a CRUD endpoint, router, or entity in this repo's server (create/list/get/update/delete handlers, new…

    23k GitHub stars~461 tokensUpdated today
    Backend & APIsAuto-check passed
  • Old Coder API Design

    AmazingAng/old-coder

    Reviews or designs an HTTP/JSON API's endpoints, auth, pagination, versioning and deprecations, guarding against inventing a bespoke interface or silently breaking consumers.

    749 GitHub starsUsed in 1 repo~3.4k tokens
    Backend & APIsAuto-check passed
  • REST API Contract Review

    decebals/claude-code-java

    Reviews REST API design for correct HTTP verbs, versioning, DTO use, consistent responses and backward compatibility before an API change ships.

    750 GitHub starsUsed in 1 repo~2.8k tokens
    Backend & APIsAuto-check passed
  • Backend Fundamentals

    DanielPodolsky/ownyourcode

    Reviews API design, REST conventions, and backend architecture.

    290 GitHub starsUsed in 1 repo~1.1k tokens
    Backend & APIsAuto-check passed

More from majiayu000/claude-skill-registry

All 971 skills in this repo
  • Deep Research

    majiayu000/claude-skill-registry

    Multi-source deep research using firecrawl and exa MCPs. An agent skill from majiayu000/claude-skill-registry.

    666 GitHub starsUsed in 6 repos~1.1k tokens
    Auto-check passed
  • Exa Search

    majiayu000/claude-skill-registry

    Neural search via Exa MCP for web, code, and company research.

    666 GitHub starsUsed in 5 repos~856 tokens
    Auto-check passed
  • Fal AI Media

    majiayu000/claude-skill-registry

    Unified media generation via fal.ai MCP — image, video, and audio.

    666 GitHub starsUsed in 5 repos~1.7k tokens
    Auto-check passed
  • Bgpt Paper Search

    majiayu000/claude-skill-registry

    Search scientific papers and retrieve structured experimental data extracted from full-text studies via the BGPT MCP server.

    666 GitHub starsUsed in 4 repos~619 tokens
    Auto-check: notes
  • Bio Alignment Pairwise

    majiayu000/claude-skill-registry

    Perform pairwise sequence alignment using Biopython Bio.Align.PairwiseAligner.

    666 GitHub starsUsed in 4 repos~1.7k tokens
    Auto-check passed
  • Open Notebook

    majiayu000/claude-skill-registry

    Self-hosted, open-source alternative to Google NotebookLM for AI-powered research and document analysis.

    666 GitHub starsUsed in 4 repos~2.4k tokens
    Auto-check passed

Categories

Questions about API Designer

What does API Designer do?

Generates complete, production-ready REST API endpoint specifications for any system or domain the user describes. API Designer is an agent skill from majiayu000/claude-skill-registry. Generates complete, production-ready REST API endpoint specifications for any system or domain the user describes.

When should I use API Designer?

API Designer fits situations like: the user asks about API design; says things like what endpoints do I need for..; design an API for...

How do I install API Designer in Claude Code?

Run `npx skills add majiayu000/claude-skill-registry --skill api-designer -a claude-code`. Or copy the skill folder (skills/api/api-designer-sickn33-agentic-awesome-skil in majiayu000/claude-skill-registry) into .claude/skills/api-designer in your project. Claude Code loads it when a task matches its description.

How do I install API Designer in Codex?

Run `npx skills add majiayu000/claude-skill-registry --skill api-designer -a codex`. Or copy the skill folder (skills/api/api-designer-sickn33-agentic-awesome-skil in majiayu000/claude-skill-registry) into .agents/skills/api-designer in your project. Codex loads it when a task matches its description.

Can I use API Designer in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add majiayu000/claude-skill-registry --skill api-designer -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/api-designer, .gemini/skills/api-designer, .github/skills/api-designer and .opencode/skills/api-designer in your project.

What does API Designer need to run?

SKILL.md names no scripts, command-line tools or credentials: API Designer is instructions for the agent only.

Does API Designer access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is API Designer safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does API Designer use?

API Designer is published under the MIT licence (declared in SKILL.md). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does API Designer use?

About 1.6k tokens (SKILL.md is roughly 6.5k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to API Designer?

Skills that share tags, products or a category with API Designer: API Designer (Jeffallan/claude-skills, 12k stars), Nodejs Backend Patterns (ever-works/ever-works, 158 stars), Pangolin CRUD Endpoints (fosrl/pangolin, 23k stars) and Old Coder API Design (AmazingAng/old-coder, 749 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains API Designer?

majiayu000 (a GitHub user) maintains it in majiayu000/claude-skill-registry, which has 666 GitHub stars. The repository holds 971 skills in this directory. The repository was last updated on October 7, 2026.

Source: majiayu000/claude-skill-registry on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.