⏳ This skill is pending AI review.
Scores will appear once the review pipeline completes.
api-contract-review
Review REST API contracts for HTTP semantics, versioning, backward compatibility, and response consistency. Use when user asks "review API", "check endpoints", "REST review", or before releasing API changes.
Choose how to use this skill
You do not need every option. Choose the path your AI client supports. The stable page stays the same; versioned files are immutable.
1. Native installer
This listing has no registered native installer command. Use the complete package or source fallback below, depending on what your client supports.
Do not guess an installer command or replace an existing version without reviewing the diff.
2. Complete package recommended
Download the ZIP when available. It includes SKILL.md plus the references, security notes and version metadata.
No complete ProSkills package is published for this listing yet.3. Prompt-only
Copy the prompt above when the agent can read the stable page or when you want to adopt the workflow without installing a skill.
Need only the instruction file?
Download SKILL.md only if your client requires a single file. The complete ZIP is safer for a full installation because it preserves the references and release context.
No path installs or executes anything by itself. Your agent still needs access to the project files. Before updating, compare the installed version and review the diff.
// RATINGS
Not yet listed on ClawHub or SkillsMP
// README
API Contract Review Skill
Audit REST APIs for HTTP semantics, versioning, and consistency
What It Does
Reviews REST API design for:
- HTTP verb correctness (GET vs POST vs PUT vs PATCH)
- API versioning strategy
- Request/response structure (DTOs vs entities)
- Status code usage (no 200 with error body)
- Backward compatibility concerns
When to Use
- "Review this API" / "Check REST endpoints"
- Before releasing API changes
- Reviewing controller PRs
- Checking if API follows REST best practices
Key Concepts
Audit vs Template
| spring-boot-patterns | api-contract-review |
|---|---|
| How to write controllers | Review existing APIs |
| Templates and examples | Checklist and anti-patterns |
| Creating new code | Auditing existing code |
Common Issues Caught
| Issue | Example |
|---|---|
| Wrong verb | POST for search instead of GET |
| No versioning | /users instead of /v1/users |
| Entity leak | JPA entity returned directly |
| 200 with error | {"status": "error"} with HTTP 200 |
| Breaking change | Required field added to request |
Example Usage
You: Review the API in UserController
Claude: [Checks HTTP verb usage]
[Validates versioning]
[Looks for entity leaks]
[Reviews error handling]
[Identifies breaking changes]
What It Checks
- HTTP Semantics - Correct verb for operation
- URL Design - Versioning, naming conventions
- Request Handling - Validation, DTOs
- Response Design - DTOs, pagination, consistency
- Error Handling - Status codes, error format
- Compatibility - Breaking vs non-breaking changes
Related Skills
spring-boot-patterns- Templates for writing controllers (this skill audits them)security-audit- Security aspects of APIsjava-code-review- General code review (this skill is API-specific)
References
// HOW IT'S BUILT
KEY FILES