toolcacheAI Coding Prompts › API Design & Documentation Generator

API Design & Documentation Generator

💻 Coding✓ Essential
Design a RESTful API for [PROJECT].

Project: [WHAT THE API DOES]
Resources: [MAIN ENTITIES — E.G. USERS, PRODUCTS, ORDERS]
Authentication: [JWT / API KEY / OAUTH / NONE]

Provide:
1. **Resource Design**: Endpoints for each resource (CRUD operations)
2. **URL Structure**: RESTful URL naming conventions
3. **Request/Response**: Sample request bodies and response formats for key endpoints
4. **Error Handling**: Standard error response format and common error codes
5. **Authentication Flow**: How auth works for each endpoint
6. **Pagination**: How to handle paginated results
7. **Filtering & Sorting**: Query parameter design for filtering and sorting
8. **Rate Limiting**: Rate limit strategy and headers
9. **Versioning**: API versioning strategy (URL vs header)
10. **OpenAPI/Swagger Spec**: A starter spec document I can build on
🔒

Unlock this prompt

You have 5 free unlocks remaining

or
Get unlimited access from £2.99 →

How to use this prompt

Copy the prompt above and paste it into ChatGPT, Claude, Gemini, or any AI assistant. Replace the bracketed placeholders with your specific details.

Leave a Review

Tried this prompt? Let us know how it worked — your reviews help other users find the best prompts.

Get Unlimited Access →Browse All 2,400 Prompts