API Contract Review

Audita controller Spring/REST per verbi HTTP, versioning, codici di stato e compatibilità

di decebals · decebals/claude-code-java

Promosso ★ 8.8/10

API Contract Review — Audita controller Spring/REST per verbi HTTP, versioning, codici di stato e compatibilità

Cosa fa

Revisiona i controller API REST (focalizzati su Java/Spring) contro una checklist di 6 punti che copre la semantica dei verbi HTTP, il versioning degli URL, le perdite DTO-vs-entity, la correttezza dei codici di stato, il formato delle risposte di errore e la compatibilità retroattiva. Si attiva quando l'utente chiede di revisionare un'API, controllare endpoint REST, o prima di rilasciare modifiche API. Si accoppia con spring-boot-patterns, che scrive controller mentre questa li audita.

Rapporto di test

Recuperati SKILL.md + README tramite API GitHub/raw; entrambi i file referenziati restituiscono HTTP 200, frontmatter ha nome+descrizione, nessun script esterno, nessun odore di sicurezza (solo innocui suggerimenti inline di grep). Scritto un SpringUserController con problemi piantati (GET per delete, POST per aggiornamento idempotente, no /v1/, ritorno entity, null se mancante, Map status:200 body) e prodotti due revisioni. Il baseline ha rilevato il GET-delete, il ritorno null, la perdita di entity, e la paginazione mancante ma HA MANCATO il versioning, il verbo PUT/POST errato, l'anti-pattern 200-con-status-body, e la mancanza di @Valid; la revisione skill ha rilevato tutti questi e organizzato i risultati per le 6 categorie, eliminando rumore di igiene fuori tema (iniezione costruttore). Giudizio trigger: carica su "revisiona gli endpoint REST in UserController", "controlla la mia API prima di rilasciarla", "i miei verbi HTTP/codici di stato sono corretti"; correttamente NON carica su "scrivi un nuovo controller REST per gli ordini" (creazione, non audit) o "revisiona il mio schema DB per l'indicizzazione" (non REST) — 5/5.

Testato il: 2026-07-21 · Claude Code 2.x (agent harness)

Installazione

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.

Comandi e prompt di esempio

  • /api-contract-reviewAudita controller Spring/REST per verbi HTTP, versioning, codici di stato e compatibilità

Gli skill si attivano con richieste in linguaggio naturale, senza comandi da ricordare. Dopo l'installazione, prompt come questi lo attivano (in inglese):

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