skills.rest
ralvarezdev
ralvarezdevCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

api-contract-reviewer

Assesses REST and gRPC contracts for breaking changes and drift using architectural rules.

3|Updated Feb 26, 2026
Search Tags:#openapi#review#diff#protobuf#contract#grpc#rest-api
One-click install
npx skills add https://github.com/ralvarezdev/ralvaskills --skill api-contract-reviewer-ralvarezdev
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-contract-reviewer
Source: https://github.com/ralvarezdev/ralvaskills/tree/main/skills/quality/api-contract-reviewer
Command: npx skills add https://github.com/ralvarezdev/ralvaskills --skill api-contract-reviewer-ralvarezdev

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Reviews REST + gRPC contracts for stability, versioning hygiene, and completeness. Catches the contract issues architects encoded rules against before they ship to clients.

Core Features & Use Cases

  • Reviews REST OpenAPI specs and protobuf definitions for stability and compatibility against established rules.
  • Applies rules from rest-api-architect, protobuf-architect, and grpc-architect to detect drift, breaking changes, and versioning issues.
  • Generates severity-keyed findings with evidence and actionable fixes; integrates with buf breaking and openapi-diff in CI.

Quick Start

Review the updated OpenAPI and protobuf definitions and generate a findings report.

Frequently Asked Questions about api-contract-reviewer

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

FAQPage Schema
How do I detect breaking changes in OpenAPI specs and protobuf definitions?▼

To detect breaking changes in OpenAPI specs and protobuf definitions, review REST and gRPC contracts against architectural rules to surface drift or compatibility issues. This process produces a severity-keyed findings table with actionable fixes.

What is API contract review for REST and gRPC stability?▼

API contract review for REST and gRPC stability is the process of auditing wire contracts against established architectural rules. It catches versioning hygiene issues, contract drift, and breaking changes before they ship to clients.

Can I use buf breaking and openapi-diff to enforce contract rules in CI?▼

Yes, you can integrate contract review with buf breaking, openapi-diff, and OpenAPI validation in CI. This automation evaluates OpenAPI and proto file changes against stability rules to prevent deploying incompatible API updates.

How do I audit gRPC contracts for versioning and compatibility issues?▼

You audit gRPC contracts for versioning and compatibility by applying rules from grpc-architect and protobuf-architect to proto file changes. This identifies wire contract drift and generates a report with severity levels and evidence.

What is the best way to review handler code that touches REST API wire contracts?▼

The best way to review handler code touching REST API wire contracts is to evaluate it alongside OpenAPI specs using rest-api-architect rules. This surfaces breaking changes and stability issues before clients are impacted.

Related Skills

Explore More Software Engineering Skills→
MysMonMysMon
2

api-design

Design contract-first APIs with OpenAPI, GraphQL SDL, and Protobuf contracts.

Community
Advanced
HZeroxiumHZeroxium

java-contract-testing

Validate OpenAPI specs and Pact contracts in CI pipelines.

Community
Advanced
nksethnkseth

api-designer

Architect REST and GraphQL APIs by producing OpenAPI 3.1 specifications.

Community
Advanced
vladm3105vladm3105
16

contract-tester

Validate API contracts and detect breaking changes across OpenAPI/AsyncAPI specifications.

Community
Advanced