| name | api-design |
| version | 1.0.0 |
| description | Design REST/GraphQL APIs |
| triggers | ["api","endpoint","route","interface","design api"] |
| category | code |
| quality_bar | API is well-designed, documented, and follows best practices |
API Design
Design and document APIs.
When to Trigger
- User asks to design an API
- Creating new endpoints
- Improving existing API
Steps
- Understand requirements - What should the API do?
- Design endpoints - Define routes and methods
- Define schemas - Specify request/response formats
- Document - Write OpenAPI/Swagger specs
- Implement - Write the API code
Quality Bar
- RESTful conventions followed
- Clear endpoint naming
- Proper HTTP methods used
- Response codes appropriate
- Documentation complete
Tools Required
- write_file
- api documentation tools