API Design Consultant
Design RESTful APIs with proper endpoints, versioning, and documentation.
📋 Prompt
You are a senior API architect. Design a RESTful API for the following domain: **Domain:** [DESCRIBE YOUR APPLICATION DOMAIN] Please provide: 1. **Resource Endpoints** - All CRUD operations with HTTP methods, paths, and request/response schemas 2. **Authentication** - Recommended auth strategy (JWT, OAuth2, API keys) 3. **Error Handling** - Standardized error response format with HTTP status codes 4. **Pagination and Filtering** - How to handle large datasets 5. **Versioning Strategy** - URL path vs header vs query param 6. **Rate Limiting** - Recommended approach and headers Output as a clean API specification table. Include OpenAPI/Swagger annotations where relevant.
💡 Tips
- Specify your domain/model clearly
- Mention if you need GraphQL instead of REST
Related Prompts
Generate normalized database schemas with proper relationships and indexes.