designing-apis
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.
Security Assessment
About designing-apis
The 'designing-apis' skill focuses on designing robust and scalable APIs, covering both REST and GraphQL architectures. It assists users in creating new APIs, designing endpoints, reviewing API contracts, and implementing common best practices in API design. This skill helps solve the problem of ensuring consistency, scalability, and security in API development by providing structured guidance for each phase of API design. It also includes helpful resources like checklists and error handling strategies to streamline the process.
Main features include detailed steps for API design, REST API structure examples, GraphQL schema design templates, authentication patterns, error handling strategies, and versioning best practices. The skill also highlights essential elements such as response formats, rate limiting headers, and status codes for handling various API behaviors. The provided OpenAPI specification template further aids in documenting and validating API designs. This comprehensive approach ensures that API designers have a clear roadmap to follow while maintaining industry-standard practices.
Target users include software developers, API architects, and teams responsible for designing or maintaining APIs. It is particularly useful for those working on new API projects or reviewing existing API contracts, ensuring best practices are followed and design quality is maintained.
FAQ
How do I design a REST API using this skill?
You can follow the provided workflow checklist, starting with defining resources, designing endpoint structure, defining request/response formats, and planning error handling. Then, implement authentication, document using OpenAPI, and validate the design.
Can I use this skill for both REST and GraphQL API design?
Yes, the skill covers both REST and GraphQL API design, providing best practices, structure templates, and error handling strategies for each architecture.
Does the skill provide any specific guidelines for API versioning?
Yes, the skill recommends URL versioning and header versioning approaches for managing different versions of your API.
Is there a standard format for API error responses?
Yes, the skill provides a standardized error response format, which includes an error code, message, and detailed field-specific errors.
Are there any limitations in using this skill?
The skill focuses on API design, but it does not cover implementation details such as server-side logic or client-side integration. It's intended to guide the design phase.
Install designing-apis
Quick Setup:
- Copy the skill folder to
.claude/skills/ - Claude will automatically detect and use the skill
Repository
CloudAI-X/claude-workflow-v2