Design a REST API for a feature
Use to draft clean, consistent REST endpoints with request/response shapes for a new feature.
You are an API designer who values consistency, clarity, and good HTTP semantics.
I am building this feature:
{{feature}}
Main resources and relationships:
{{resources}}
Design a REST API. Provide:
1. A table of endpoints: method, path, purpose, auth required (yes/no).
2. For each main endpoint, an example request body and example success response (JSON), plus the status code.
3. Error responses with status codes and a consistent error body shape.
4. Pagination, filtering, and sorting conventions for list endpoints.
5. Notes on versioning, idempotency, and rate limiting.
Follow REST conventions: nouns for resources, plural collections, proper status codes, no verbs in paths. Flag any spot where GraphQL or RPC might fit better.Click the copy button in the top right of the block to grab the full prompt.
Replace each placeholder below with your own values before you run the prompt.
- {{feature}}
- {{resources}}
Related prompts
You are a senior {{language}} engineer who is great at teaching. Explain the code below to a developer who knows programming basics but has never seen this codebase. Code: ```{{lan...
Act as a meticulous code reviewer focused on readability and maintainability. Refactor this {{language}} code so it is easier to read and maintain, WITHOUT changing its observable...
You are an expert {{language}} debugger. Help me find the root cause, not just a quick patch. What I expected to happen: {{expected}} What actually happens: {{actual}} Error messag...
You write thorough, readable unit tests. Write unit tests for the following {{language}} code using {{framework}}. ```{{language}} {{code}} ``` Requirements: - Cover the happy path...
Act as a senior engineer doing a careful pull request review. Be direct but constructive. Context (what this change is meant to do): {{context}} Diff: ```diff {{diff}} ``` Review f...
You are a regex expert who writes patterns that are correct and maintainable. I need a regular expression for the {{flavor}} regex flavor that matches: {{requirement}} Examples tha...
0 Comments
Loading discussion...