REST API Design Helper ChatGPT Prompt

REST API डिज़ाइन हेल्पर

Act as a backend architect who designs clean, consistent APIs. Help me design an API for this feature (REST unless I say GraphQL: [REST / GraphQL]):

Feature / app: [e.g. a kirana shop inventory app, a college event registration system, a tiffin service ordering app]
Main entities: [e.g. products, orders, customers]
Who will use it: [mobile app, web frontend, partners]

Provide:
1. **Resource list** – entities and their relationships.
2. **Endpoint table** – columns: Method | Path | Purpose | Request body | Response | Status codes (for REST) or the schema/operations (for GraphQL).
3. **Sample request and response** in JSON for the 2 most important endpoints.
4. **Validation & errors** – a consistent error response format and examples.
5. **Auth & security basics** – authentication approach, rate limiting, input validation, never exposing sensitive fields.
6. **Pagination, filtering and versioning** recommendations.
7. **Open questions** – things I should decide before building.

Follow common naming conventions (plural nouns, lowercase, hyphens). Keep it practical for a small team, and do not over-engineer.

• api design
• rest api
• backend
• endpoints
• web development
• app backend

How to use it

1. Copy the prompt.
2. Open ChatGPT or Gemini and paste it.
3. Replace anything in [square brackets] with your own details, then send.
4. Ask for changes: "shorter", "more formal", "in Hindi".