skills.rest
mzffreyvazov
mzffreyvazovCOMMUNITY
Explore all skills by this author →
GitHub

api-contract-review

Audit REST API contracts for HTTP verbs, versioning, and error handling.

1|Updated May 30, 2025
Search Tags:#versioning#api#rest#http#backward-compatibility#contracts#api-review
One-click install
npx skills add https://github.com/mzffreyvazov/yt-to-spotify2 --skill api-contract-review-mzffreyvazov
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-contract-review
Source: https://github.com/mzffreyvazov/yt-to-spotify2/tree/main/.agents/skills/api-contract-review
Command: npx skills add https://github.com/mzffreyvazov/yt-to-spotify2 --skill api-contract-review-mzffreyvazov

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

REST API contracts often drift from intended semantics, versioning, and error handling, leading to clients breaking or misusing endpoints.

Core Features & Use Cases

  • Audit HTTP verb usage, endpoint design, versioning strategy, and error handling for consistency.
  • Detect DTO vs entity leakage, inconsistent response shapes, and missing or inconsistent pagination.
  • Use case: When preparing a PR, run this skill to surface breaking changes and suggested migrations.

Quick Start

Review the REST API contracts in your repository to identify improvements.

Frequently Asked Questions about api-contract-review

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

FAQPage Schema
How do I audit REST API contracts for backward compatibility?▼

REST API contract audits review HTTP verb usage, endpoint design, versioning strategy, and error handling to detect semantic drift and ensure backward compatibility across the API surface.

What is the best way to detect DTO vs entity leakage in REST APIs?▼

Detecting DTO vs entity leakage in REST APIs involves assessing your response shapes to ensure data transfer objects are used properly rather than exposing raw database entities directly to clients.

How do I check HTTP verb usage and endpoint design for REST APIs?▼

Checking HTTP verb usage and endpoint design for REST APIs involves evaluating whether endpoints follow correct semantic conventions and maintaining response consistency across the entire API surface.

Can I use an API review to surface breaking changes before a pull request?▼

Yes, you can use an API review to surface breaking changes before a pull request by auditing pagination, error handling, and versioning strategy to identify required modifications and migration paths.

How do I create a migration path for breaking changes in API versioning?▼

Creating a migration path for breaking changes in API versioning requires assessing your current versioning strategy and error handling to formulate a concise remediation plan with concrete changes.

Related Skills

Explore More Software Engineering Skills→
jhlee0409jhlee0409
4

openapi-parser

Parse OpenAPI 3.x and Swagger 2.0 specs into structured endpoint catalogs.

Community
Advanced
spallempatispallempati

integration-test-contracts

Enforce integration test and contract validation standards for microservices.

Community
Advanced
abhishekdutta18abhishekdutta18

plankton-code-quality

Run formatters and linters to enforce code quality during file edits.

Community
Intermediate
wojonswojons
4

code-migration

Plan, execute and validate framework/library migrations with automated tools and breaking-change analysis.

Community
Advanced