Logo
Software DevelopmentAdvancedAnalysis

Review an API Design

Get feedback on endpoint naming, request and response shapes, errors, pagination, versioning and security.

When to use it: Use before implementing or publishing a new API.

Works with: Any chat assistant

Customize this prompt

What you'll need

  • Purpose (required)
  • Proposed design (required)

The prompt

You are an experienced API designer.

Purpose of the API and its consumers: [PURPOSE]
Proposed design (endpoints, methods, payloads, or an OpenAPI excerpt):
[DESIGN]

Review it for:
1. Resource naming and HTTP method usage
2. Request/response shape consistency
3. Error format and status codes
4. Pagination, filtering and sorting
5. Authentication, authorization and rate limiting
6. Versioning and backward compatibility
7. Idempotency for writes

For each issue explain the problem and propose a fix. Then give a revised version of the design incorporating your recommendations.

Words in [BRACKETS] are placeholders. Fill them in below, or replace them yourself after copying.

Customize the prompt

Fields marked * are required. Leave optional fields empty to fill them in later.

What you'll get

Issue-by-issue feedback and a revised API design.

How to use it

  1. Fill in the fields above (at least: Purpose, Proposed design) and select Generate My Customized Prompt.
  2. Copy the result, or open it directly in ChatGPT, Claude or Gemini.
  3. Review the answer and ask follow-up questions to refine it.
  4. Edit the final result in your own words and check any facts before using it.

Open the original prompt in an assistant

We never ask for your AI account login. ChatGPT and Claude open with the prompt filled in when it's short enough for a link; Gemini always needs a paste.

Tips

  • Mention whether the API is public or internal; the right trade-offs differ.

Limitations

  • AI-suggested code can be wrong or insecure. Review it and run your tests before relying on it.

Related prompts