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
Vibe Coding App Spec Writer
Turn a raw app idea into a precise, AI-ready specification document optimized for vibe coding tools like Bolt.new, Lovable, and NxCode.
Excel VBA Automation Script
Generate VBA macros to automate Excel tasks
Few-Shot Learning Prompt Builder
Create effective few-shot learning prompts with examples that teach AI models new tasks quickly.
Agentic Code Architect
Generate autonomous agent code with self-correction, planning, and execution capabilities