API Contract Review

Prüft Spring/REST-Controller auf HTTP-Verben, Versionierung, Statuscodes und Kompatibilität

von decebals · decebals/claude-code-java

Getestet · Funktioniert ★ 8.8/10

API Contract Review — Prüft Spring/REST-Controller auf HTTP-Verben, Versionierung, Statuscodes und Kompatibilität

Was es kann

Überprüft REST API-Controller (Java/Spring-fokussiert) anhand einer 6-Punkte-Checkliste, die HTTP-Verb-Semantik, URL-Versionierung, DTO-vs-Entity-Lecks, Korrektheit von Statuscodes, Fehlerantwortformat und Abwärtskompatibilität abdeckt. Wird ausgelöst, wenn der Benutzer eine API überprüfen, REST-Endpunkte prüfen oder vor der Veröffentlichung von API-Änderungen fragt. Passt zu spring-boot-patterns, das Controller schreibt, während dieser sie prüft.

Testbericht

SKILL.md + README über GitHub API/raw abgerufen; beide referenzierten Dateien geben HTTP 200 zurück, Frontmatter hat Name+Beschreibung, keine externen Skripte, keine Sicherheitsrisiken (nur harmlose Inline-Grep-Tipps). Einen Spring UserController mit eingebauten Problemen geschrieben (GET-basierte Löschung, POST für idempotentes Update, kein /v1/, Entity-Rückgabe, null-bei-Fehlern, Map status:200 body) und zwei Reviews erstellt. Baseline fing GET-Löschung, Null-Rückgabe, Entity-Leck und fehlende Paginierung ab, VERPASSTE aber Versionierung, das falsche PUT/POST-Verb, das 200-mit-Status-Body-Anti-Pattern und fehlendes @Valid; die Skill-Review fing all diese ab und organisierte die Ergebnisse nach den 6 Kategorien, während sie irrelevante Hygiene-Geräusche (Konstruktor-Injektion) wegließ. Trigger-Beurteilung: lädt bei "review the REST endpoints in UserController", "check my API before I release", "are my HTTP verbs/status codes right"; lädt korrekt NICHT bei "write a new REST controller for orders" (Erstellung, nicht Audit) oder "review my DB schema for indexing" (nicht REST) – 5/5.

Getestet am: 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.

Befehle & Beispiel-Prompts

  • /api-contract-reviewPrüft Spring/REST-Controller auf HTTP-Verben, Versionierung, Statuscodes und Kompatibilität

Skills reagieren auf normale Anfragen — keine Slash-Befehle nötig. Nach der Installation aktivieren Prompts wie diese den Skill (auf Englisch):

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