skills.rest
xinbenlv
xinbenlvCOMMUNITY
Explore all skills by this author →
Website𝕏@ZainanZhouGitHub

codereview-api

Analyze API contracts to detect breaking changes and ensure backward compatibility.

8|Updated Jan 14, 2026
Search Tags:#versioning#api#review#breaking-changes#contracts#api-design
One-click install
npx skills add https://github.com/xinbenlv/codereview-skills --skill codereview-api
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: codereview-api
Source: https://github.com/xinbenlv/codereview-skills/tree/main/skills/codereview-api
Command: npx skills add https://github.com/xinbenlv/codereview-skills --skill codereview-api

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps API teams maintain stable contracts across versions by automatically auditing endpoints, schemas, and responses for backward compatibility. It reduces the risk of breaking changes hitting consumers and streamlines API governance.

Core Features & Use Cases

  • Contract Enforcement: Validate that public API contracts meet defined standards and do not regress.
  • Breaking Change Detection: Identify removed endpoints, renamed fields, or changed schemas.
  • Versioning & Design Review: Assess versioning strategy, documentation quality, and consistency for public interfaces.
  • Use Case: When reviewing a new public REST or RPC interface, run this Skill to compare against existing contracts and surface breaking changes.

Quick Start

Trigger the code review on API surfaces by providing the surface description, for example: Review API surface for v2 contracts and surface any potential breaking changes.

Frequently Asked Questions about codereview-api

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

FAQPage Schema
How do I detect breaking changes in my REST API contracts?▼

You can detect breaking changes in REST API contracts by automatically auditing endpoints, event schemas, and responses to identify removed endpoints, renamed fields, or changed schemas, ensuring backward compatibility across public interfaces.

What is API contract enforcement and why is it needed?▼

API contract enforcement is the process of validating that public API contracts meet defined standards and do not regress. It is needed to reduce the risk of breaking changes hitting consumers and to streamline API governance across versions.

How do I review versioning strategy for public RPC interfaces?▼

You can review versioning strategy for public RPC interfaces by assessing documentation quality, design consistency, and versioning reviews across public interfaces to compare new contracts against existing ones and surface potential breaking changes.

Can I use this to validate event schemas for backward compatibility?▼

Yes, you can validate event schemas for backward compatibility. The analysis applies to event schemas and versioning reviews across public interfaces, enforcing contract design and reporting actionable guidance for developers.

What's the best way to prevent API regressions before releasing a new version?▼

The best way to prevent API regressions is to run an automated contract review comparing new public interfaces against existing contracts. This surfaces breaking changes early and provides actionable guidance for developers and product teams.

Related Skills

Explore More Software Engineering Skills→
LerianStudioLerianStudio
205

writing-api-docs

Document REST endpoints with request/response schemas and error codes.

Official
Advanced
enchantednaturesenchantednatures

api-design

Design standardized REST, GraphQL, and gRPC APIs with versioning and error handling.

Community
Advanced
heaptracetechnologyheaptracetechnology
13

contract-test

Automate API contract testing with schema validation and OpenAPI checks.

Community
Advanced
constellizeconstellize
1

write-contract-tests

Generate strict contract tests from constellation-map.md and code-generation-plan files.

Official
Advanced