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
Technical Changelog Writer
Generate professional changelogs from a list of code changes or commits
On-Device AI App Feature Planner
Plans a mobile app feature set that runs entirely on-device using small AI models like Gemma 4 or Llama, with offline-first architecture and privacy-by-design principles.
Chain-of-Verification Generator
Generate self-verifying prompts that ask the AI to check its own outputs against criteria
Technical Changelog & Release Notes Writer
Converts raw developer notes, commit messages, or pull request descriptions into polished, user-friendly changelog entries and release notes for multiple audiences.