🔌
API Design Prompts
Design professional REST or GraphQL APIs with OpenAPI/Swagger specifications.
3Ready Prompts
✓Free Forever
⚡Instant Copy
💡 How to Use These Prompts
- Click Copy on any prompt below
- Replace the
[brackets]with your info - Paste into ChatGPT, Gemini, or Claude
📋 API Design Prompts
1
API Architect & Designer
ROLE: You are a Principal API Architect specializing in scalable, developer-friendly REST and GraphQL interfaces. OBJECTIVE: Generate a comprehensive API specification (OpenAPI/Swagger/GraphQL Schema). INPUT CONTRACT: - Service Name/Goal - Key Resources (e.g., 'Users', 'Orders', 'Payments') - Auth Requirements CONSTRAINTS: 1. Follow 'RESTful Best Practices' (Resource naming, HTTP verbs, Status codes). 2. Include 'Schema Validation' (Required fields, Types, Constraints). 3. Design 'Meaningful Error Responses'. 4. Ensure the spec is 'Implementation-agnostic'. QUALITY BAR: The specification should be a 'Contract' that frontend and backend developers can use to build in parallel. OUTPUT FORMAT: - OpenAPI YAML/JSON or GraphQL Schema - Documentation Summary
2
GraphQL Schema Master
ROLE: You are a GraphQL Expert. OBJECTIVE: Design a type-safe GraphQL schema for a complex data relationship. INPUT CONTRACT: - Data model (e.g., 'Social Media feed with comments and likes') CONSTRAINTS: - Use 'Queries', 'Mutations', and 'Subscripts'. - Handle 'Pagination' via Relay style. QUALITY BAR: Must be clean and performant for mobile apps. OUTPUT FORMAT: - GraphQL .graphql file
3
Versioning & Breaking Changes Expert
ROLE: You are an API Product Manager. OBJECTIVE: Design a path for versioning an API (v1 -> v2) without breaking users. INPUT CONTRACT: - The breaking change (e.g., 'Field X is now an Array') CONSTRAINTS: - Propose 'Header-based' or 'URL-based' versioning. - Write a 'Migration Notice' for devs. QUALITY BAR: Must minimize developer friction. OUTPUT FORMAT: - Versioning Strategy
🎯 Pro Tips for Better Results
- 1Be specific with your requirements for better api design results.
- 2If the first response isn't perfect, ask the AI to "refine" or "improve" it.
- 3Try adding "for Indian audience" to customize the output for your context.
Ready to Create?
Copy a prompt and paste into your favorite AI
❓ Frequently Asked Questions
How do I use these api design prompts?
▼
Simply copy any prompt, replace the bracketed placeholders with your information, and paste it into ChatGPT, Gemini, or Claude. The AI will generate personalized content for you.
Which AI model works best for api design?
▼
All prompts work great with ChatGPT (free or Plus), Google Gemini, and Claude. For api design, we recommend ChatGPT or Claude for best results.
Are these prompts really free?
▼
Yes! All prompts on PromptDost are 100% free forever. No login required, no limits, no hidden costs.