API Design Review

Review API designs for consistency, versioning, authentication, and error-handling issues.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/MS33834/AI-SKILL --skill api-design-review-ms33834
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: API Design Review
Source: https://github.com/MS33834/AI-SKILL/tree/main/skills/api-design-review
Command: npx skills add https://github.com/MS33834/AI-SKILL --skill api-design-review-ms33834

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps teams catch API design issues before they become production headaches, reducing confusion, client breakage, and inconsistent behavior across services.

Core Features & Use Cases

  • Consistency Review: Checks naming, paths, HTTP methods, status codes, and error shapes for coherence.
  • Versioning Guidance: Evaluates URL or header versioning strategies and how breaking changes are handled.
  • Security and Auth Review: Assesses authentication, authorization, and scope design.
  • Operational Quality: Reviews pagination, filtering, retry signals, and documentation completeness.
  • Use Case: Use it when you are preparing a new API, refining an existing endpoint set, or reviewing a spec against team conventions.

Quick Start

Ask the Skill to review your API spec or endpoint description together with any team conventions, and it will return severity-ranked findings plus concrete recommendations.

Frequently Asked Questions about API Design Review

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

FAQPage Schema
How do I review an OpenAPI spec for consistency and error handling issues?▼

To review an OpenAPI spec for consistency, submit the spec and team conventions to receive severity-ranked findings. This review checks naming, paths, HTTP methods, status codes, and error shapes, providing concrete rewrite recommendations to align with documentation expectations.

What is the best way to evaluate API versioning strategies for breaking changes?▼

Evaluating API versioning strategies involves analyzing URL or header versioning approaches to assess how breaking changes are handled. This process produces severity-ranked findings and concrete recommendations aligned with team conventions during new API launches and standardization reviews.

How do I check my API design for authentication and authorization flaws?▼

Checking API designs for authentication and authorization flaws involves assessing security, auth, and scope design within the interface. Submitting the endpoint design yields severity-ranked findings and concrete rewrite recommendations to improve operational quality and security posture.

Can I use an API design review for endpoint lists that are still in progress?▼

Yes, you can review in-progress interface designs and endpoint lists. Submitting in-progress designs during new API launches or standardization reviews produces severity-ranked findings and concrete rewrite recommendations for pagination, filtering, retry signals, and documentation completeness.

Why does my API pagination and filtering design fail standardization reviews?▼

API pagination and filtering designs fail standardization reviews due to inconsistent operational quality and incomplete documentation. A review assesses these aspects alongside team conventions, returning severity-ranked findings and concrete rewrite recommendations to resolve the issues.