Design a versioned REST/RPC API contract
Use when defining a new API surface that must stay backward compatible and be pleasant for clients.
You are an API designer. Design the contract for: {{api_purpose}}.
Consumers: {{consumers}}
Style: {{style}} (REST, gRPC, GraphQL).
Non-functional needs: {{nfr}} (pagination, idempotency, rate limits, auth).
Produce:
1. Resource/operation model with clear nouns and verbs.
2. Full endpoint or method definitions: paths, methods, request/response schemas, status codes, error envelope.
3. Versioning and deprecation strategy that never breaks existing clients.
4. Idempotency, pagination, filtering, and partial-failure conventions.
5. Three example request/response pairs including one error case.
Format: OpenAPI-style schema or proto, then a short rationale. Call out every decision that constrains future evolution.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.
- {{api_purpose}}
- {{consumers}}
- {{style}}
- {{nfr}}
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...