api-contract-review
Audit your REST API design against best practices for HTTP verb selection, versioning strategies, and status code correctness. Catches common mistakes like wrong HTTP methods, missing API versions, entity leaks, and improper error handling that break client compatibility.
API Contract Review audits REST endpoints for HTTP semantics, versioning, and backward compatibility issues.
AI-generated summary based on this skill's SKILL.md
Decision gist · record as of 2026-02-08
API Contract Review audits REST endpoints for HTTP semantics, versioning, and backward compatibility issues. Audit your REST API design against best practices for HTTP verb selection, versioning strategies, and status code correctness. Catches common mistakes like wrong HTTP methods, missing API versions, entity leaks, and improper error handling that break client compatibility.
Use it when
- api-contract-review reviews REST API contracts for HTTP semantics and correctness.
- Yes.
Verify before relying
Read SKILL.md below before installing (2 files). Open directory: indexed for reading, not audited.
Install
decebals/claude-code-java/api-contract-review · repository language: Shell
Open directory. Skills are indexed for reading, not audited. Review a skill's body before installing it.
Frequently asked questions
AI-generated answers based on this skill's SKILL.md and metadata
What does api-contract-review check in my REST API endpoints?
api-contract-review audits your REST API design against best practices for HTTP verb selection, versioning strategies, and status code correctness. It catches common mistakes like wrong HTTP methods, missing API versions, entity leaks, and improper error handling that break client compatibility.
How can I review my REST API endpoints for HTTP semantics?
api-contract-review reviews REST API contracts for HTTP semantics and correctness, validating that your endpoints use appropriate HTTP verbs, status codes, and response patterns. It checks controller HTTP verb usage and ensures your API follows REST conventions.
Can api-contract-review audit my API versioning strategy?
Yes. api-contract-review audits API versioning and backward compatibility, including versioning in URL paths and deprecation strategy. It identifies breaking changes before releasing API updates and validates your approach to maintaining client compatibility across versions.
What response design issues does api-contract-review validate?
api-contract-review validates response design, DTOs, and error handling patterns. It checks for entity leaks in REST responses, validates DTO vs entity usage, reviews API status codes and error handling, and audits REST API security in error responses to prevent anti-patterns like 200 OK errors.
Does api-contract-review check endpoint naming conventions?
Yes. api-contract-review checks endpoint naming, URL structure, and design consistency. It validates REST endpoint naming conventions and ensures your API follows consistent design patterns across all routes.
How does api-contract-review help identify breaking changes?
api-contract-review reviews your API for breaking changes before releasing updates. By auditing versioning strategy, backward compatibility, deprecation practices, and response consistency, it helps you catch compatibility issues that would break existing clients.
SKILL.md
Rendered from the published skill. Quoted content, verbatim.
API Contract Review Skill
Audit REST API design for correctness, consistency, and compatibility.
When to Use
- User asks "review this API" / "check REST endpoints"
- Before releasing API changes
- Reviewing PR with controller changes
- Checking backward compatibility
Quick Reference: Common Issues
| Issue | Symptom | Impact |
|---|---|---|
| Wrong HTTP verb | POST for idempotent operation | Confusion, caching issues |
| Missing versioning | /users instead of /v1/users |
Breaking changes affect all clients |
| Entity leak | JPA entity in response | Exposes internals, N+1 risk |
| 200 with error | {"status": 200, "error": "..."} |
Breaks error handling |
| Inconsistent naming | /getUsers vs /users |
Hard to learn API |
HTTP Verb Semantics
Verb Selection Guide
| Verb | Use For | Idempotent | Safe | Request Body |
|---|---|---|---|---|
| GET |
(truncated - see the full file via the links below)
File tree — 2 files
.claude/skills/api-contract-review/README.md
.claude/skills/api-contract-review/SKILL.md
Let your AI agent find skills like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 56,283 agent skills by what they can do, searchable in plain language.
wish › “Review REST API contracts for HTTP semantics and correctness”
Give your agent the search over MCP, or paste the wish link into any chat. No install? Search from any chat →
Related skills
This skill guides you through building well-structured REST APIs in Spring Boot, covering resource-based URL design, proper HTTP method usage, appropriate status codes, and DTO patterns. It includes strategies for validation, global exception handling, pagination setup, and security header configuration. Use it when creating endpoints, designing API contracts, or reviewing REST architecture.
Master Spring Boot architecture through practical patterns for REST API design, service layering, data access, caching, and async operations. Covers controller-service-repository organization, validation, exception handling, pagination, and observability for production-grade Java applications.
This skill teaches Spring Boot's layered architecture pattern, organizing code into controllers, services, repositories, and entities. It covers REST endpoint design, JPA relationships with lazy loading, DTOs for request/response handling, transactional boundaries, and global exception handling.
This skill streamlines your code review workflow by automatically identifying and applying fixes for actionable feedback left on pull requests. It handles both inline comments and general review remarks, saving you time on repetitive corrections and letting you focus on substantive improvements to your codebase.
This skill helps you scan and assess your project's dependencies for updates and security issues while keeping your codebase untouched. It's part of Turbo, a modular framework designed to streamline agentic development workflows with Claude Code.
This skill queries npm to compare your declared SDK versions against the latest published releases for Claude Code, Claude Agent SDK, and Codex SDK. It generates a status table showing which packages are current or outdated, then analyzes the version gap and release notes for each outdated package to help you assess update risk before installing.
More skills Worktree Pr (NOASSERTION)