API Contract Review

Auditerer Spring/REST controllere for HTTP-verber, versionering, statuskoder og kompatibilitet

Af decebals · decebals/claude-code-java

Testet · Virker ★ 8.8/10

API Contract Review — Auditerer Spring/REST controllere for HTTP-verber, versionering, statuskoder og kompatibilitet

Hvad det gør

Gennemgår REST API controllere (Java/Spring-fokuseret) mod en 6-punkts tjekliste, der dækker HTTP-verbum-semantik, URL-versionering, DTO-vs-entity-lækager, statuskode-korrekthed, fejl-responsformat og bagudkompatibilitet. Udløses, når brugeren beder om at gennemgå en API, tjekke REST-endpoints eller før frigivelse af API-ændringer. Parres med spring-boot-patterns, som skriver controllere, mens denne auditerer dem.

Testrapport

Hentet SKILL.md + README via GitHub API/rå; begge refererede filer returnerer HTTP 200, frontmatter har navn+beskrivelse, ingen eksterne scripts, ingen sikkerhedsrisici (kun harmløse inline grep-tips). Skrev en SpringUserController med plantede problemer (GET-baseret sletning, POST for idempotent opdatering, ingen /v1/, entity-retur, null ved mangel, Map status:200 body) og producerede to anmeldelser. Baslinen fangede GET-sletning, null-retur, entity-lækage og manglende paginering, men MISSEDE versionering, den forkerte PUT/POST-verbum, 200-med-status-body anti-mønsteret og manglende @Valid; skill-anmeldelsen fangede alle disse og organiserede fundene efter de 6 kategorier, mens den droppede irrelevant hygiejnestøj (constructor injection). Trigger-bedømmelse: indlæses ved "gennemgå REST-endpoints i UserController", "tjek min API før jeg frigiver", "er mine HTTP-verber/statuskoder korrekte"; indlæses korrekt ikke ved "skriv en ny REST controller til ordrer" (oprettelse, ikke audit) eller "gennemgå mit DB-skema for indeksering" (ikke REST) — 5/5.

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

Kommandoer og eksempelprompter

  • /api-contract-reviewAuditerer Spring/REST controllere for HTTP-verber, versionering, statuskoder og kompatibilitet

Skills udløses af almindelige forespørgsler — ingen kommandoer at huske. Efter installationen aktiverer prompter som disse skillen (på engelsk):

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