Skip to main content
kitlocal.dev

Review a REST API design

Reviews an endpoint or OpenAPI snippet for naming, status codes, error shape, pagination, idempotency and compatibility, ranked by impact.

Prompts are text you copy into your own assistant. KitLocal does not run them.

Fill in the variables

What you type stays in this browser. It is not added to the URL, saved, or sent anywhere.

Preview

Still needed: Endpoints or OpenAPI fragment

Review this HTTP API design. Consumers: . Breaking changes allowed: No.

Check: resource naming, method semantics, status codes, one consistent error shape,
pagination and filtering, idempotency of unsafe retries, authentication and authorization
per endpoint, and backward compatibility. Rank findings as Blocker / Should fix / Nice to have,
each with the exact endpoint, why it matters and a concrete alternative.
Say clearly what you could not judge from the text provided.

Design:
{{spec}}

Purpose

Catch contract problems before clients depend on them.

When to use it

  • You are about to publish or change an HTTP API.

What to prepare

  • An OpenAPI fragment or a list of endpoints with sample requests and responses.

Expected output

Findings grouped by Blocker, Should fix and Nice to have.

About this catalog

Bundled snapshot · published Nov 15, 2026, 6:05 AM · Catalog revision 5bc079fe355af2214bc0

Showing the snapshot bundled with this app (no content source is configured). Newer content may exist at the source.