api-reviewer

Review API contracts against PRDs and generate compliance reports.

79|23|Updated Jan 6, 2026
One-click install
npx skills add https://github.com/TestAny-io/testany-agent-skills --skill api-reviewer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-reviewer
Source: https://github.com/TestAny-io/testany-agent-skills/tree/main/plugins/testany-eng/skills/api-reviewer
Command: npx skills add https://github.com/TestAny-io/testany-agent-skills --skill api-reviewer

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

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.

Frequently Asked Questions about api-reviewer

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

FAQPage Schema
How do I validate OpenAPI spec alignment with my PRD?

To validate OpenAPI spec alignment with a PRD, run an automated contract review that checks completeness, consistency, and scope ownership. The reviewer generates a concise compliance report highlighting gaps and mapping contract definitions directly to PRD evidence indexes.

Does API contract review work with AsyncAPI and GraphQL definitions?

Yes, API contract review supports multi-protocol definitions including AsyncAPI, GraphQL, gRPC, Webhook, and SDK. It applies protocol-specific checklists to validate interface completeness, error models, and versioning compatibility across multi-team environments.

What is evidence-based API contract review?

Evidence-based API contract review enforces conclusions by pointing to exact locations in PRD and contract indexes. This mechanism prevents misinterpretations or missed requirements by ensuring every validation result is traceable to source documentation.

Can I check OpenAPI contracts for conflicts with existing SDKs and events?

Yes, you can check OpenAPI contracts for conflicts with existing interfaces, events, or SDKs. The review process identifies clashes and flags potential duplications to ensure contract integrity and consistency before releases.

How do I review gRPC and Webhook contracts for multi-team environments?

Review gRPC and Webhook contracts by running an automated validation against finalized PRD boundaries. The reviewer enforces protocol-specific checklists to verify ownership and alignment, producing a compliance report for multi-team release coordination.

What is the best way to prevent missed requirements in API contract definitions?

The best way to prevent missed requirements in API contracts is to automate rigorous PRD-to-contract alignment checks before releases. This ensures contracts serve as a single truth source by validating scope, error models, and versioning against PRD evidence.