API Design & Documentation Generator
Design RESTful or GraphQL APIs with OpenAPI specs, error handling, and developer documentation
Content
Design a complete API for {{api_purpose}}. API style: {{api_style}} Auth method: {{auth_method}} Expected scale: {{scale}} Generate: 1. **Resource Design**: Entities, relationships, and URL structure 2. **Endpoints List**: Method, path, description, request/response schemas 3. **OpenAPI 3.1 Spec**: Complete YAML specification 4. **Error Handling**: Standard error codes with descriptive messages 5. **Rate Limiting Strategy**: Tiers and headers 6. **Pagination**: Cursor vs offset approach with examples 7. **Versioning Strategy**: URL vs header versioning recommendation 8. **SDK Code Samples**: {{languages}} client examples 9. **Developer Guide**: Quick-start tutorial for common use cases 10. **Webhook Design**: Event types and payload schemas if applicable
Related Prompts
MCP Server Integration Planner
Plan and design Model Context Protocol server integrations for AI applications
Data Pipeline Architecture Review
Review and optimize data pipeline architectures for performance and reliability
API Design Reviewer
Review and improve REST API designs with best practices
API Integration Troubleshooter
Diagnoses API integration issues, generates fixes, and produces a structured debugging report with root cause analysis, corrected code, and prevention checklist.