Skip to content
New this week26 prompts for Sora, Veo and Runway video workflows.
Explore video prompts→
AIPrompt123Prompt library

Search AIPrompt123

Search prompts, categories, platforms and repositories

Design a REST API contract

Design a REST API contract with a prompt built for Claude and ChatGPT. It supplies context, constraints and an output contract, then asks the model to surface assumptions and gaps. Copy it, fill the variables and treat the result as a structured draft, not a final answer.

4.8(24 ratings)1.7k copies
Updated By Site Admin
41 words · v1.2

Fill in the blanks · 1 variable

Claude promptReplace every highlighted token before sending
<task>
Design a REST API for {feature}. Provide resource names, endpoints, request and response schemas, status codes, pagination, filtering, idempotency, auth scopes and error format. Include three example requests and responses. Call out the two decisions most likely to cause future pain.
</task>

Think carefully before answering. Keep any reasoning separate and put the final deliverable inside <answer> tags.
Open in Claude

Comments

Share what worked, what broke and which model you used. Comments appear after posting and are moderated for spam.

Saved with an anonymous browser ID. No login needed.

How to use this prompt

  1. 1

    Open Claude and start a new chat. Paste the prompt exactly as written.

  2. 2

    Replace each placeholder ({feature}) with your own details. Leave the instructions and the output format untouched.

  3. 3

    Add one concrete example or data point if the model's first answer is vague. Specific input produces specific output.

  4. 4

    Run it once, then ask for a single revision with a specific critique rather than regenerating from scratch.

  5. 5

    Review the result. Reproduce the bug, review the diff and run the tests in a clean environment.

Worked example

This is the kind of input the prompt expects and the shape of output it produces. Your result will differ with the model and the details you supply.

Example input

Feature: your feature

Example output

**Diagnosis:** the handler reads `req.body` before the JSON middleware runs, so the body is undefined on POST requests. **Fix:** move the middleware above the route registration and add a guard for missing bodies. No public API changes. **Verification:** added a failing test for an empty JSON body, confirmed it fails, applied the fix, then ran the full suite. The test now passes and the unrelated snapshot tests are unchanged.

Tips for a better result

  • Paste the full error and the smallest relevant code, not a screenshot of the stack trace.
  • Ask for a plan before allowing multi-file edits; it prevents sprawling refactors.
  • Require a failing test first and a verification command at the end.
  • Change one variable at a time and compare the outputs; it is the fastest way to learn what this model responds to.

Common mistakes

  • Accepting a confident fix without reproducing the bug or running tests.
  • Letting the assistant rewrite entire files when a three-line diff would do.
  • Pasting secrets, tokens or customer data into a hosted model.
Verified Knowledge · FAQ

Questions about this prompt

Practical answers about running the design a rest api contract prompt.

Related prompts

Same job, a different angle — or the next step in the workflow.

Optimise an N+1 query

Optimise an N+1 query with a prompt built for Claude and Cursor. It supplies context, constraints and an output contract, then asks the model to surface assumptions and gaps. Copy it, fill the variables and treat the result as a structured draft, not a final answer.

ClaudeCursorChatGPT
4.9(76)1.7k copies

Review an architecture diagram in text

A coding prompt for review an architecture diagram in text. It gives Claude and ChatGPT a clear role, explicit constraints and a defined output, so the first answer is closer to usable. Fill in the variables, run it once, then use the verification notes on this page to review the result.

ClaudeChatGPT
4.8(48)1.1k copies
Coding & Developer
Intermediate

Debug an error with a minimal reproduction

This copy-ready coding prompt helps you debug an error with a minimal reproduction with fewer blank-page decisions. Paste it into Cursor and Claude, fill the variables, and you get a structured first draft you can edit. It is written for repeatable results and tells you what to check before publishing.

CursorClaudeChatGPT
4.9(67)1.1k copies

Written and reviewed by Site Admin

Author & Platform Administrator

Administrator and lead editor at AIPrompt123, curating high-performance AI prompts, SEO/AEO/GEO strategies, and developer repositories.

Last reviewed 13 March 2026 · version 1.2 · tested on Claude, ChatGPT