designing-apis
Conventions for designing and reviewing consistent RESTful API endpoints.
Install
mkdir -p .claude/skills/designing-apis-pengfeng && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/13934" && unzip -o skill.zip -d .claude/skills/designing-apis-pengfeng && rm skill.zipInstalls to .claude/skills/designing-apis-pengfeng
Activation
This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.
REST API design patterns — endpoints, routes, routers, resources, HTTP methods, status codes, pagination, error responses, versioning. Use when designing, reviewing, or refactoring API endpoints.Key capabilities
- →Design resource URLs with plural nouns and hyphens
- →Apply appropriate HTTP methods for API actions
- →Return correct HTTP status codes
- →Implement consistent error response formats
- →Support pagination for collection endpoints
How it works
The skill applies conventions for designing or reviewing REST API endpoints, covering URL structure, HTTP methods, status codes, error formats, and pagination.
Inputs & outputs
When to use designing-apis
- →Designing api endpoints
- →Refactoring api routes
- →Reviewing status code responses
- →Implementing pagination
About designing-apis
Enforces resource-based URL naming, appropriate HTTP method usage, standard status code responses, and consistent error messaging for API development.
REST API design patterns — endpoints, routes, routers, resources, HTTP methods, status codes, pagination, error responses, versioning. Use when designing, reviewing, or refactoring API endpoints.
Limitations
- →Nesting of resources is limited to a maximum of 2 levels.
How it compares
This skill provides specific conventions for REST API design, unlike general software development practices.
Compared to similar skills
designing-apis side by side with the closest alternatives in the catalog.
| Skill | Installs | Updated | Safety | Difficulty |
|---|---|---|---|---|
| designing-apis (this skill) | 0 | 4mo | No flags | Intermediate |
| api-design-principles | 72 | 4mo | No flags | Intermediate |
| nodejs-backend-patterns | 12 | 4mo | No flags | Intermediate |
| designing-apis | 1 | 7mo | No flags | Intermediate |
Try saying
Example prompts that trigger this skill in your AI assistant.
You might also like
api-design-principles
wshobson
Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers. Use when designing new APIs, reviewing API specifications, or establishing API design standards.
nodejs-backend-patterns
wshobson
Build production-ready Node.js backend services with Express/Fastify, implementing middleware patterns, error handling, authentication, database integration, and API design best practices. Use when creating Node.js servers, REST APIs, GraphQL backends, or microservices architectures.
designing-apis
CloudAI-X
Designs REST and GraphQL APIs including endpoints, error handling, versioning, and documentation. Use when creating new APIs, designing endpoints, reviewing API contracts, or when asked about REST, GraphQL, or API patterns.
graphql-architect
sickn33
Master modern GraphQL with federation, performance optimization, and enterprise security. Build scalable schemas, implement advanced caching, and design real-time systems. Use PROACTIVELY for GraphQL architecture or performance optimization.
api-engineering
weirdgme
Guide to API design patterns, GraphQL, gRPC, API gateways, rate limiting, and versioning strategies.
api-designer
lushly-dev
>