Aller au contenu principal
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.

Cette ressource n’est disponible qu’en anglais.

Les prompts sont du texte que vous copiez dans votre propre assistant. KitLocal ne les exécute pas.

Renseigner les variables

Ce que vous saisissez reste dans ce navigateur. Cela n’est ni ajouté à l’URL, ni enregistré, ni envoyé.

Aperçu

Encore requis : 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}}

Objectif

Catch contract problems before clients depend on them.

Quand l’utiliser

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

Ce qu’il faut préparer

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

Résultat attendu

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

À propos de ce catalogue

Instantané intégré · publié 15 nov. 2026, 06:05 · Révision du catalogue 5bc079fe355af2214bc0

Affichage de l’instantané intégré à l’application (aucune source de contenu n’est configurée). Du contenu plus récent peut exister à la source.