Design a RESTful API for [FEATURE/RESOURCE].
For each endpoint, provide:
- HTTP method and URL path (following REST conventions)
- Request body schema (JSON with types and validation rules)
- Response body schema (success and error cases)
- Authentication requirements
- Rate limiting recommendation
- Example curl command
Also include:
- Pagination strategy (cursor vs offset)
- Error response format (consistent across all endpoints)
- API versioning approach
- Webhook design for async events (if applicable)
Use OpenAPI 3.0 compatible descriptions.
Design a RESTful API for [FEATURE/RESOURCE].
For each endpoint, provide:
- HTTP method and URL path (following REST conventions)
- Request body schema (JSON with types and validation rules)
- Response body schema (success and error cases)
- Authentication requirements
- Rate limiting recommendation
- Example curl command
Also include:
- Pagination strategy (cursor vs offset)
- Error response format (consistent across all endpoints)
- API versioning approach
- Webhook design for async events (if applicable)
Use OpenAPI 3.0 compatible descriptions.
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.