Does it support both REST and RPC?

Yes, it is designed to analyze RESTful endpoints, RPC services, event schemas, and general service-to-service contracts.

How does it detect breaking changes?

The skill scans for removed endpoints, renamed fields, changed data types, and new required parameters that would break existing API integrations.

How does it help with API versioning?

It checks for consistent versioning strategies in URLs or headers and ensures that appropriate deprecation notices are provided for legacy code.

What does the API Contract Guardian skill do?

It analyzes code changes to ensure API contracts remain stable, follow design best practices, and do not introduce unintentional breaking changes for consumers.

Can it improve my API error handling?

Absolutely. It validates that error codes are stable and programmatically accessible, and that sensitive information like stack traces are not leaked in production responses.

API Contract Guardian

Name: API Contract Guardian
Author: xinbenlv

byxinbenlv

0•

API Development

Ensures API stability and consistency by identifying breaking changes and validating contract adherence during code reviews.

The API Contract Guardian skill empowers Claude to act as a specialized API platform engineer, focusing on the integrity of public and internal interfaces. It systematically analyzes REST/RPC endpoints, event schemas, and versioning strategies to prevent regressions and long-term technical debt. By scanning for modified response structures, new required request parameters, and status code shifts, it helps developers maintain robust backward compatibility and follow high-quality API design patterns like REST best practices and idempotency.

Key Features

01Automated breaking change detection for endpoints and response schemas

02Standardized reporting for API review findings and migration paths

03Validation of backward compatibility and proper deprecation paths

04Comprehensive input/output validation and error code consistency checks

05Evaluation of idempotency and RESTful design best practices

060 GitHub stars

Use Cases

01Reviewing pull requests that modify public-facing REST or RPC interfaces

02Planning version migrations to ensure existing consumers are not impacted

03Auditing service contracts for consistency in pagination and error handling

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add xinbenlv/codereview-skills codereview-api

For use in Claude.ai and ChatGPT

Download Skill