API Design Architect

Coding & Dev Prompts ChatGPT (GPT-4o) 5 views 0 copies

Design a production-ready RESTful API with complete documentation and security patterns.

Prompt

Design a RESTful API for [Application Name] that handles [Core Functionality]. Tech stack: [Backend language/framework]. Database: [DB type].

Provide complete API specification:
1. Resource naming conventions
2. Endpoint structure (all CRUD operations)
3. HTTP methods and status codes
4. Request/Response schemas (JSON)
5. Authentication/Authorization design (JWT/OAuth)
6. Rate limiting strategy
7. Versioning approach
8. Error response format
9. Pagination pattern
10. Filtering, sorting, searching parameters
11. Webhook design (if needed)
12. OpenAPI/Swagger documentation format
13. API security checklist
14. Testing strategy

Output as a complete API documentation draft.

How To Use This Prompt

Describe your application, main resources/entities, and tech stack.

Example Output

          Resource: /api/v1/users\nGET /users - List users (paginated)\nPOST /users - Create user\nGET /users/{id} - Get user...        

Frequently Asked Questions

What is the "API Design Architect" prompt used for?

Design a production-ready RESTful API with complete documentation and security patterns.

Which AI models work with this prompt?

This prompt works best with ChatGPT (GPT-4o). You can also try it with other large language models for similar results.

Can I modify this prompt?

Yes! Feel free to copy and customize this prompt to better fit your specific needs. You can change names, industries, tones, or any other variables to personalize the output.

Is this prompt free to use?

Absolutely. All prompts on GetPromptPro are free to copy and use for personal or commercial purposes.