skills.rest
decebals
decebalsCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

api-contract-review

Audit REST API contracts for correctness, versioning, and backward compatibility.

700|137|Updated Jan 30, 2026
Search Tags:#versioning#backward-compatibility#api-design#rest-api#http-semantics#api-contract-review
One-click install
npx skills add https://github.com/decebals/claude-code-java --skill api-contract-review
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-contract-review
Source: https://github.com/decebals/claude-code-java/tree/main/.claude/skills/api-contract-review
Command: npx skills add https://github.com/decebals/claude-code-java --skill api-contract-review

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Audit REST API contracts for correctness, versioning, and backward compatibility to prevent breaking changes and misaligned designs.

Core Features & Use Cases

  • Review HTTP verb usage, URL versioning, DTO vs entity boundaries, and error handling.
  • Identify backward compatibility risks and versioning gaps in public APIs.
  • Provide actionable recommendations and a standardized checklist for API reviews.

Quick Start

Ask Claude Code to review the API surface of your project by saying review this API.

Frequently Asked Questions about api-contract-review

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I review a REST API for backward compatibility and breaking changes?▼

Auditing REST API contracts involves validating HTTP verb semantics, URL versioning strategies, and DTO boundaries to identify breaking changes. It enforces consistent response formats and robust error codes to prevent misaligned designs and ensure backward compatibility across API versions.

What is the best way to validate HTTP verb semantics and error handling in an API?▼

Validating HTTP verb semantics requires auditing REST API contracts to ensure endpoints use correct methods and return robust error codes. This approach checks DTO boundaries and response formats, providing actionable recommendations to fix misaligned designs and standardize API behavior.

Can I use this to audit URL versioning strategies and DTO boundaries for public APIs?▼

Yes, you can audit public API URL versioning strategies and DTO boundaries by reviewing the API surface. This identifies versioning gaps and backward compatibility risks, providing a standardized checklist to validate endpoint contracts and entity usage before release planning.

How do I check REST API contracts during pull request reviews?▼

To check REST API contracts during pull request reviews, apply the audit to PR changes to validate endpoint modifications, DTO usage, and error handling. This enforces HTTP verb semantics and detects backward compatibility risks before merging code changes.

When do I need to audit REST API contracts for release planning?▼

You need to audit REST API contracts for release planning when validating new endpoints, DTO changes, and versioning strategies. This identifies backward compatibility risks and versioning gaps in public APIs, ensuring standardized response formats and robust error codes before deployment.

Related Skills

Explore More Software Engineering Skills→
tranhieutttranhieutt
70

api-design

Review REST and GraphQL API contracts for naming, schema, auth, and versioning issues.

Community
Intermediate
OzeroHAXOzeroHAX
32

coder-system-design-api-design

Enforce HTTP API design rules for versioning, errors, pagination, and idempotency.

Community
Intermediate
Muath2000Muath2000

api-contracts-auditor

Audit OpenAPI specifications against Zod DTO schemas for endpoint parity.

Community
Advanced
wesleyosantos91wesleyosantos91
6

contract-review

Evaluate API and data contracts for breaking changes and compatibility.

Community
Intermediate