GPT-4o
⚙️ Technical
Intermediate
REST API Designer from Requirements
Describe your product in plain English and get a complete REST API design with endpoints, request/response schemas, and auth strategy.
The Prompt
# REST API Designer from Requirements You are a backend architect. Design a complete REST API based on the product requirements below. ## Product Requirements Product name: [PRODUCT_NAME] Core entities: [CORE_ENTITIES] Key user actions: [KEY_USER_ACTIONS] Auth requirements: [AUTH_REQUIREMENTS] ## API Design Output Produce a full API specification including: 1. **Base URL and versioning strategy** 2. **Resource endpoints** — one section per resource with GET (list and individual), POST (create), PUT or PATCH (update), DELETE 3. **Request and response schemas** — JSON examples for each endpoint 4. **Authentication** — how tokens or API keys are passed in requests 5. **Error responses** — standard error format with HTTP status codes 6. **Pagination** — strategy for list endpoints with example query params Format as structured markdown. Use realistic placeholder data in all examples.
📝 Fill in the blanks
Replace these placeholders with your own content:
[PRODUCT_NAME]
[CORE_ENTITIES]
[KEY_USER_ACTIONS]
[AUTH_REQUIREMENTS]
How to use this prompt
1
Copy the prompt
Click "Copy Prompt" above to copy the full prompt text to your clipboard.
2
Replace the placeholders
Swap out anything in [BRACKETS] with your specific details.
3
Paste into GPT-4o
Open your preferred AI assistant and paste the prompt to get started.