api-design
Design API endpoints, schemas, and contracts. Use when defining public interfaces or data models.
提供方 amattas|开源
API Design
Define the interface contracts for APIs, including endpoints, request/response schemas, and error handling.
Process
- Review spec.md and architecture.md
- Define endpoints and HTTP methods
- Design request and response schemas
- Define error responses and codes
- Consider versioning strategy
Output
Create api-design.md using the template in templates/api-design.md.
Tips
- Use consistent naming conventions
- Design for backwards compatibility
- Include example payloads
- Document rate limits if applicable
- Consider pagination for list endpoints