Skip to content
Log in

API Design Review

Reviews an API for the mistakes that cannot be fixed later — naming, error semantics and anything that becomes a breaking change.

0

Share this prompt

Free — no card needed

Create a free account

to open API Design Review — and the other 364 prompts across 21 categories.

We store your email address to send these. We never sell it or pass it to advertisers. Withdraw at any time. Privacy Policy.

Already have an account?

CategoryCodingForDevelopersTested onClaudeChatGPTGemini

Running it, start to finish

  1. Paste the design with who consumes it and your versioning policy.
  2. Fix everything in section 1 before publishing.
  3. Write the consumer code from section 8 yourself and see if you agree.

What you get back

The output this produces, every time.

  • Prioritises decisions that become breaking changes, which are the only ones still cheap.
  • Checks whether resources model the consumer's mental model or your database schema.
  • Writes the consumer's actual code, which surfaces awkwardness nothing else does.

Getting better results

Where this usually goes wrong, and how to avoid it.

  • Fix names before anything else. A bad name is permanent the moment someone integrates. A bad implementation behind a good name is a Tuesday.
  • Decide what null means. Section 7 prevents a whole category of consumer bug that will otherwise be reported to you for years.
  • Read section 8 carefully. If the common task takes four calls and a client-side join, the resource modelling is wrong regardless of how clean each endpoint looks.

More Coding prompts

All Coding

Written for The AI University. Every prompt in this library is original work — authored, tested and revised here, not collected from elsewhere. 365 of them, free with an account.