api-designing
Design consistent RESTful API endpoints, request/response formats, and error handling patterns. Use when creating new API routes, designing API structure, planning request/response schemas, or establishing API conventions. Triggers on requests like "design an API for", "create API endpoints", "plan the API structure", "design the response format", or "API conventions".
npx skills add majiayu000/claude-skill-registry --skill api-designing --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 Designing Design consistent RESTful APIs for this Next.js application. ## Process 1. **Identify resources** - What entities does the API manage? 2. **Define operations** - CRUD and custom actions 3. **Design endpoints** - URL structure and methods 4. **Specify schemas** - Request/response formats 5. **Plan error handling** - Consistent error responses ## RESTful Conventions ### URL Structure ``` /api/[resource] # Collection /api/[resource]/[id] # Individual resource /api/[resource]/[id]/[sub] # Nested resource ``` ### HTTP Methods | Method | Purpose | Idempotent | |--------|---------|------------| | GET | Retrieve resource(s) | Yes | | POST | Create resource | No | | PUT | Replace resource | Yes | | PATCH | Partial update | Yes | | DELETE | Remove resource | Yes | ### Existing Project Patterns Admin routes follow this structure: ``` /admin/api/articles GET (list), POST (create) /admin/api/articles/[id] GET, PUT, DELETE /admin/api/tags GET, POST /admin/api/media GET, POST /admin/api/users GET, POST /admin/api/users/[id]/approve POST (action) ``` ## Request Schemas ### List Endpoints (GET collection) Query parameters: ``` ?page=1 # Pagination ?limit=10 # Items per page ?sort=cr
- Process
- RESTful Conventions
- URL Structure
- HTTP Methods
- Existing Project Patterns
- Request Schemas
- List Endpoints (GET collection)
- Create/Update (POST/PUT)
- Response Schemas
- Success Responses
- Error Responses
- Implementation Pattern
- Validation
- Output
What does the api-designing skill do?
Design consistent RESTful API endpoints, request/response formats, and error handling patterns. Use when creating new API routes, designing API structure, planning request/response schemas, or establishing API conventions. Triggers on requests like "design an API for", "create API endpoints", "plan the API structure", "design the response format", or "API conventions".
How do I install it?
Run `npx skills add majiayu000/claude-skill-registry --skill api-designing --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.