api-design-assistant
Design and review APIs with suggestions for endpoints, parameters, return types, and best practices. Use when designing new APIs from requirements, reviewing existing API designs, generating API documentation, or getting implementation guidance. Supports REST APIs with focus on endpoint structure, request/response schemas, authentication, pagination, filtering, versioning, and OpenAPI specifications. Triggers when users ask to design, review, document, or improve APIs.
npx skills add majiayu000/claude-skill-registry --skill api-design-assistant --agent claude-code
Same command for any agent — swap --agent for codex, cursor, copilot.
Weekly change comes from our own snapshots, not the repository page — it measures attention, not adoption.
# API Design Assistant ## Overview Assist with designing well-structured, RESTful APIs by suggesting endpoints, parameters, return types, and best practices. Generate OpenAPI specifications and provide implementation guidance. ## Workflow ### 1. Understand Requirements When designing a new API or reviewing an existing one, first understand: **For new API design:** - What is the domain/purpose of the API? - What resources need to be exposed? (users, products, orders, etc.) - What operations are needed? (create, read, update, delete, custom actions) - Who are the consumers? (web app, mobile app, third-party integrations) - Are there specific requirements? (authentication, rate limiting, versioning) **For API review:** - What are the existing endpoints? - What issues or improvements are needed? - Are there consistency problems? - Are best practices being followed? ### 2. Design or Review API Structure Follow these steps based on the use case: #### Designing New APIs **Step 1: Identify Resources** Map domain concepts to API resources: - User management → `/users` - Product catalog → `/products` - Order processing → `/orders` - User's orders → `/users/{userId}/orders` **Step 2: Define E
- Overview
- Workflow
- 1. Understand Requirements
- 2. Design or Review API Structure
- 3. Apply Best Practices
- 4. Generate Documentation
- 5. Handle Common Scenarios
- Example Workflows
- Example 1: Design API from Requirements
- Example 2: Review Existing API
- Example 3: Generate Documentation
- Tips for Effective API Design
- References
What does the api-design-assistant skill do?
Design and review APIs with suggestions for endpoints, parameters, return types, and best practices. Use when designing new APIs from requirements, reviewing existing API designs, generating API documentation, or getting implementation guidance. Supports REST APIs with focus on endpoint structure, request/response schemas, authentication, pagination, filtering, versioning, and OpenAPI specifications. Triggers when users ask to design, review, document, or improve APIs.
How do I install it?
Run `npx skills add majiayu000/claude-skill-registry --skill api-design-assistant --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.