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
Reasoning Model Debug Prompt (Chain-of-Thought Code Fixer)
Uses chain-of-thought reasoning to systematically diagnose and fix code bugs, explaining each step of the reasoning process before proposing a fix.
Developer Onboarding Documentation Writer
Generates comprehensive, developer-friendly onboarding documentation for APIs, SDKs, or open-source projects — covering quickstart guides, authentication, code examples, and troubleshooting.
AI Debugging Chain-of-Thought Assistant
Apply systematic chain-of-thought reasoning to diagnose and fix complex bugs, with step-by-step analysis, hypothesis testing, and a clear fix with explanation.
AI Model Fine-Tuning Dataset Brief Generator
Generates a structured brief and example training data pairs for fine-tuning an LLM on a specific task, persona, or domain.