API Contract Review

Granskar Spring/REST-kontrollers för HTTP-verb, versionering, statuskoder och kompatibilitet

av decebals · decebals/claude-code-java

Testad · Fungerar ★ 8.8/10

API Contract Review — Granskar Spring/REST-kontrollers för HTTP-verb, versionering, statuskoder och kompatibilitet

Vad den gör

Granskar REST API-kontrollers (Java/Spring-fokuserad) mot en 6-punktschecklista som täcker HTTP-verbsemantik, URL-versionering, DTO-vs-entitet-läckor, statuskodkorrekthet, fel-svarsformat och bakåtkompatibilitet. Triggers när användaren ber att granska ett API, kontrollera REST-slutpunkter, eller före release av API-ändringar. Parar med spring-boot-patterns, som skriver kontrollers medan denna granskar dem.

Testrapport

Hämtade SKILL.md + README via GitHub API/rå; båda refererade filer returnerar HTTP 200, frontmatter har namn+beskrivning, inga externa skript, inga säkerhetslukter (endast ofarliga inline grep-tips). Skrev en SpringUserController med planterade problem (GET-baserad radering, POST för idempotent uppdatering, ingen /v1/, entitetsretur, null vid miss, Map status:200 body) och producerade två granskningar. Baslinjen fångade GET-radering, null-retur, entitetsläcka, och saknad paginering men MISSADE versionering, fel PUT/POST-verb, 200-med-status-body anti-mönstret, och saknad @Valid; färdighetsgranskningen fångade alla dessa och organiserade fynd enligt de 6 kategorierna samtidigt som den släppte irrelevant hygienbrus (konstruktorinjektion). Trigger-bedömning: laddas på "granska REST-slutpunkterna i UserController", "kontrollera mitt API innan jag släpper", "är mina HTTP-verb/statuskoder rätt"; laddas korrekt inte på "skriv en ny REST-kontroller för ordrar" (skapande, inte granskning) eller "granska mitt DB-schema för indexering" (inte REST) — 5/5.

Testad: 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.

Kommandon och exempelprompter

  • /api-contract-reviewGranskar Spring/REST-kontrollers för HTTP-verb, versionering, statuskoder och kompatibilitet

Skills triggas av vanliga förfrågningar — inga kommandon att memorera. Efter installationen aktiverar prompter som dessa skillen (på engelska):

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