API Contract Review

Audite les contrôleurs Spring/REST pour les verbes HTTP, le versioning, les codes de statut et la compatibilité

par decebals · decebals/claude-code-java

Testé · Fonctionne ★ 8.8/10

API Contract Review — Audite les contrôleurs Spring/REST pour les verbes HTTP, le versioning, les codes de statut et la compatibilité

Ce que fait

Examine les contrôleurs d'API REST (centrés sur Java/Spring) par rapport à une liste de contrôle en 6 points couvrant la sémantique des verbes HTTP, le versioning des URL, les fuites DTO-vs-entité, la correction des codes de statut, le format des réponses d'erreur et la compatibilité ascendante. Se déclenche lorsque l'utilisateur demande d'examiner une API, de vérifier les endpoints REST, ou avant de publier des modifications d'API. S'associe à spring-boot-patterns, qui écrit les contrôleurs tandis que celui-ci les audite.

Rapport de test

Récupéré SKILL.md + README via GitHub API/raw ; les deux fichiers référencés renvoient HTTP 200, le frontmatter a name+description, aucun script externe, aucune faille de sécurité (seulement des conseils grep en ligne bénins). Écrit un Spring UserController avec des problèmes implantés (suppression basée sur GET, POST pour mise à jour idempotente, pas de /v1/, retour d'entité, null-on-miss, corps Map status:200) et produit deux revues. La référence a détecté la suppression GET, le retour null, la fuite d'entité et la pagination manquante mais a MANQUÉ le versioning, le mauvais verbe PUT/POST, l'anti-pattern 200-with-status-body et le @Valid manquant ; la revue de compétence a détecté tous ceux-ci et organisé les résultats par les 6 catégories tout en éliminant le bruit d'hygiène hors sujet (injection de constructeur). Jugement de déclenchement : se charge sur "review the REST endpoints in UserController", "check my API before I release", "are my HTTP verbs/status codes right" ; ne se charge PAS correctement sur "write a new REST controller for orders" (création, pas audit) ou "review my DB schema for indexing" (pas REST) — 5/5.

Testé le: 2026-07-21 · Claude Code 2.x (agent harness)

Installation

git clone --depth 1 https://github.com/decebals/claude-code-java.git /tmp/api-contract-review-src
mkdir -p ~/.claude/skills
cp -R /tmp/api-contract-review-src/.claude/skills/api-contract-review ~/.claude/skills/api-contract-review
# Self-contained: SKILL.md + README.md only, no external scripts or deps.
# Java/Spring-oriented (Spring annotations, JPA entities), but the HTTP/REST
# checklist applies to any REST API. No API keys, no tools to install.

Commandes et exemples de prompts

/api-contract-reviewAudite les contrôleurs Spring/REST pour les verbes HTTP, le versioning, les codes de statut et la compatibilité

Les skills se déclenchent sur des demandes en langage courant — aucune commande à retenir. Après installation, des prompts comme ceux-ci l'activent (en anglais) :

Review this API for backward compatibility issues
Check these endpoints for REST semantics violations
Review the API contract before releasing v2

Rapport complet →