BestPromptFinder

REST API Design Spec From Your Requirements

Quality, usefulness and confidence are AI evaluations out of 100 — not user ratings. Community results come from visitors' "worked / didn't work" votes below. How scoring works →

The prompt

Design a REST API for my app before I write any code. What the app does: [ ] Main things (resources) it manages: [e.g. users, orders, products, invoices] Who calls the API: [my web app / mobile app / third parties] Auth: [sessions / JWT / API keys / not decided] Scale and constraints: [ ] Give me: 1. A resource list with fields and types for each. 2. An endpoint table: method, path, purpose, request body, response, status codes, who's allowed. 3. Conventions: naming, pagination, filtering, sorting, error format (one consistent JSON shape), versioning, idempotency for payments or creates. 4. Security notes: auth, rate limits, input validation, what never to return (passwords, internal IDs if sensitive). 5. An OpenAPI 3 YAML for the 3 most important endpoints. 6. Open questions I need to decide. Keep it simple; don't add endpoints or features I didn't ask for.

Why this prompt

• Hand-picked, editorially reviewed prompt
• Written for Claude, ChatGPT, Gemini

Source

Created by BestPromptFinder — editorial prompt, not user-generated. See our content & source policy.

Related Coding prompts