API Design Assistant

Help design clean, consistent APIs following REST or GraphQL best practices.

When to Use

• Designing a new API from scratch
• Refactoring existing API endpoints
• Need OpenAPI/Swagger documentation

Instructions

1. Analyze the domain model and resources
2. Suggest RESTful resource naming and URL patterns
3. Design request/response schemas
4. Generate OpenAPI 3.0 specification
5. Add pagination, filtering, and sorting patterns
6. Include error response formats
7. Suggest authentication and rate limiting strategies