API Contract Review

Audytuje kontrolery Spring/REST pod kątem czasowników HTTP, wersjonowania, kodów statusu i kompatybilności

Autor: decebals · decebals/claude-code-java

Testowano · Działa ★ 8.8/10

API Contract Review — Audytuje kontrolery Spring/REST pod kątem czasowników HTTP, wersjonowania, kodów statusu i kompatybilności

Co robi ten skill

Przegląda kontrolery API REST (skoncentrowane na Java/Spring) pod kątem 6-punktowej listy kontrolnej obejmującej semantykę czasowników HTTP, wersjonowanie URL, wycieki DTO-vs-entity, poprawność kodów statusu, format odpowiedzi na błędy i kompatybilność wsteczną. Uruchamia się, gdy użytkownik prosi o przegląd API, sprawdzenie punktów końcowych REST lub przed wydaniem zmian w API. Współpracuje z spring-boot-patterns, który pisze kontrolery, podczas gdy ten je audytuje.

Raport z testu

Pobrano SKILL.md + README za pośrednictwem GitHub API/raw; oba odwołane pliki zwracają HTTP 200, frontmatter ma name+description, brak zewnętrznych skryptów, brak zagrożeń bezpieczeństwa (tylko łagodne wskazówki grep inline). Napisano Spring UserController z celowo wprowadzonymi problemami (usuwanie oparte na GET, POST dla idempotentnej aktualizacji, brak /v1/, zwracanie encji, null w przypadku braku, Map status:200 body) i wygenerowano dwie recenzje. Wersja bazowa wychwyciła GET-delete, null-return, wyciek encji i brak paginacji, ale PRZEGAPIŁA wersjonowanie, błędny czasownik PUT/POST, antywzorzec 200-with-status-body i brak @Valid; recenzja umiejętności wychwyciła wszystkie te elementy i zorganizowała ustalenia według 6 kategorii, jednocześnie pomijając nieistotny szum higieniczny (wstrzykiwanie konstruktora). Ocena wyzwalacza: ładuje się na „review the REST endpoints in UserController”, „check my API before I release”, „are my HTTP verbs/status codes right”; poprawnie NIE ładuje się na „write a new REST controller for orders” (tworzenie, nie audyt) lub „review my DB schema for indexing” (nie REST) — 5/5.

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

Instalacja

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.

Komendy i przykładowe prompty

/api-contract-reviewAudytuje kontrolery Spring/REST pod kątem czasowników HTTP, wersjonowania, kodów statusu i kompatybilności

Skille uruchamiają się na zwykłe polecenia — bez komend do zapamiętania. Po instalacji aktywują go prompty takie jak te (po angielsku):

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

Pełny raport →