codereview-api

Community

Guard API contracts for stability.

Authorxinbenlv
Version1.0.0
Installs0

System Documentation

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.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: codereview-api
Download link: https://github.com/xinbenlv/codereview-skills/archive/main.zip#codereview-api

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.