Agent skill · Backend & API

create-api-design

Design a REST or GraphQL API from a feature specification when the user asks to design an API, create endpoints, define an API contract, or plan API resources

majiayu000github.com/majiayu000GitHub ↗
claude-codecan modify filesMIT
Install
npx skills add majiayu000/claude-skill-registry --skill create-api-design --agent claude-code

Same command for any agent — swap --agent for codex, cursor, copilot.

Facts
Files in the skill folder: 2
SKILL.md size: 12 KB
Bundled scripts: none
Version: 1.0.0
Declared author: chalk
Allowed tools: ReadGlobWriteGrep
Path: skills/api/create-api-design/SKILL.md
Open the folder on GitHub →
Where it comes from
Stars: 534
Language: HTML

Weekly change comes from our own snapshots, not the repository page — it measures attention, not adoption.

From the SKILL.md

# Create API Design ## Overview Design a complete, production-ready API from a feature specification or resource description. The output is a comprehensive API design document covering endpoints, schemas, error contracts, pagination, auth, rate limiting, and caching -- consistent with existing API patterns in the project. ## Workflow 1. **Read existing API patterns** -- Read `.chalk/docs/engineering/` for: - Existing API design documents (match naming, URL structure, and conventions) - Architecture docs describing the current API layer - Auth patterns and middleware - Error handling conventions - If no docs exist, scan the codebase for route definitions to infer patterns 2. **Scan codebase for current conventions** -- Use Grep to find: - Route definitions (e.g., `router.get`, `app.post`, `@GetMapping`, `@api_view`) - Error response shapes (look for error middleware, error classes) - Pagination patterns (cursor vs. offset, parameter names) - Auth middleware usage (JWT, API key, OAuth scopes) - Response envelope patterns (do responses wrap in `{ data, meta }` or return raw?) - Store these conventions; the new API must follow them exactly 3. **Determine the next document number** -- L

What's inside
Steps it walks through
  1. Overview
  2. Workflow
  3. Filename Convention
  4. API Design Document Format
  5. URL Design Rules
  6. Field Naming Rules
  7. Anti-patterns
Ships with 1 file
  • metadata.json
More from claude-skill-registry
All skills →
About this skill
What does the create-api-design skill do?

Design a REST or GraphQL API from a feature specification when the user asks to design an API, create endpoints, define an API contract, or plan API resources

How do I install it?

Run `npx skills add majiayu000/claude-skill-registry --skill create-api-design --agent claude-code` — it drops the skill into your project so the agent can pick it up. Swap the --agent value for codex, cursor or copilot if you use one of those.

Where does this skill come from?

From majiayu000/claude-skill-registry, a repository with 534 stars. We read it straight from the repository tree rather than a submitted listing, so what you see here is what is actually published.

Is a popular skill a good skill?

Not necessarily. Stars measure attention, not adoption — a repository can trend for a week and be abandoned. That is why we show the weekly change from our own snapshots next to the total, instead of a single flattering number.

Keep going