api-design
Installation
Summary
REST and GraphQL API design with OpenAPI documentation, versioning strategies, and best practices.
- Covers REST fundamentals including resource naming, HTTP methods, status codes, request/response formatting, and error handling patterns
- Includes pagination, filtering, sorting, and field selection query parameters with standardized response structures
- Supports multiple authentication approaches: JWT, OAuth 2.0, API keys, and session-based methods
- Provides URL and header-based versioning strategies plus OpenAPI 3.0 specification templates for API documentation
- Offers GraphQL schema design as an alternative to REST, plus 10 core best practices including security, validation, caching, and monitoring
SKILL.md
API Design
When to use this skill
- Designing new REST APIs
- Creating GraphQL schemas
- Refactoring API endpoints
- Documenting API specifications
- API versioning strategies
- Defining data models and relationships
Instructions
Step 1: Define API requirements
- Identify resources and entities
- Define relationships between entities
- Specify operations (CRUD, custom actions)
- Plan authentication/authorization
- Consider pagination, filtering, sorting