api-contract-review

Review API endpoint contracts for naming, methods, errors, auth, and pagination before implementation.

6|Updated Jul 10, 2026
One-click install
npx skills add https://github.com/Mozurok/fhorja.dev --skill api-contract-review-mozurok
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-contract-review
Source: https://github.com/Mozurok/fhorja.dev/tree/main/.claude/skills/api-contract-review
Command: npx skills add https://github.com/Mozurok/fhorja.dev --skill api-contract-review-mozurok

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? API design flaws like inconsistent naming, wrong HTTP methods, missing pagination, or weak auth models are cheap to fix on paper but expensive once coded and shipped. This Skill reviews a proposed API contract before any implementation begins, catching contract issues at the design phase. ## Core Features & Use Cases - Ten-point contract audit: Checks naming and path consistency, HTTP method correctness, request/response shape quality, error contract, auth and authorization model, pagination, idempotency, versioning, and alignment with existing endpoints. - Grounded alignment check: Reads existing route files and controllers so consistency findings are based on real code, not assumptions. - Ungrounded-claim marking: External API or vendor behaviors that lack captured references are explicitly marked as unproven rather than asserted as fact. - Use Case: Before building a new set of REST endpoints described in an implementation plan, run this review to get per-endpoint findings and a clear verdict: ready to implement, needs revision, or has blocking issues. ## Quick Start Review the API contract defined in my IMPLEMENTATION_PLAN.md for naming, methods, errors, auth, and pagination before I start coding.

Frequently Asked Questions about api-contract-review

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

FAQPage Schema
How do I review an API design before implementation?▼

Run a structured contract review that checks each proposed endpoint across naming, HTTP methods, request/response shapes, error codes, auth, pagination, idempotency, and versioning. This Skill performs that ten-point audit and returns per-endpoint findings with an overall readiness assessment.

What should an API contract review check?▼

A thorough review covers plural resource naming, correct HTTP verbs, consistent field casing and response envelopes, semantic status codes, machine-readable error codes, auth on every write endpoint, pagination on list endpoints, idempotency for side-effecting mutations, and a versioning strategy.

How is API contract review different from code review?▼

Contract review operates at the design phase before code exists, checking endpoint shapes and conventions on paper. Code review tools like review-hard inspect implemented code for correctness and safety risk after it is written.

Can this review check consistency with my existing API endpoints?▼

Yes. The review reads existing route files and controllers in the service and compares the proposed contract against actual conventions for auth middleware, error handling, response shape, and naming, rather than relying on assumptions.

When should I not use an API contract review?▼

Do not use it when the API is already implemented; post-implementation risk belongs to code review or security review instead. It also returns a no-op when there is no API contract defined in the task artifacts to review.