api-reviewer

Official

Ensure API contracts align with PRD.

AuthorTestAny-io
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This skill provides rigorous API contract reviews to ensure contracts accurately reflect PRD and align with project boundaries, preventing misinterpretations or missed requirements.

Core Features & Use Cases

  • PRD-to-Contract Alignment: Verifies that the contract documents (OpenAPI/AsyncAPI/GraphQL/gRPC/etc.) reflect the PRD scope and ownership.
  • Contract Integrity & Consistency: Checks completeness of protocol definitions, error models, versioning, and compatibility.
  • Conflict Detection: Identifies clashes with existing interfaces, events, or SDKs and flags potential duplications.
  • Use Case: Given a finalized PRD and a generated OpenAPI spec, run the reviewer to generate a concise compliance report highlighting gaps and suggested mappings.

Quick Start

Run the api-reviewer against your OpenAPI file (e.g., openapi.yaml) to validate PRD alignment and produce a review report.

Dependency Matrix

Required Modules

None required

Components

references

💻 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: api-reviewer
Download link: https://github.com/TestAny-io/testany-agent-skills/archive/main.zip#api-reviewer

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.