skills.rest
rob-broadley
rob-broadleyCOMMUNITY
Explore all skills by this author →
GitHub

api-review

Review REST HTTP API and CLI changes for breaking contract behavior.

Updated May 10, 2026
Search Tags:#authentication#error handling#api design#breaking changes#pagination#http semantics#cli conventions
One-click install
npx skills add https://github.com/rob-broadley/ai-airbase --skill api-review-rob-broadley
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-review
Source: https://github.com/rob-broadley/ai-airbase/tree/main/cadre/skills/api-review
Command: npx skills add https://github.com/rob-broadley/ai-airbase --skill api-review-rob-broadley

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It prevents fragile or inconsistent REST/HTTP and CLI interfaces by enforcing stable naming, correct HTTP semantics, reliable error envelopes, and change-safety before callers are impacted.

Core Features & Use Cases

  • Contract-first API review for REST HTTP APIs and CLI interfaces, focusing on long-term caller correctness.
  • Standards coverage across naming consistency, HTTP method semantics, error response shape, breaking-change detection, and CLI conventions.
  • Scalability and evolution checks for pagination, authentication behavior, and versioning strategies using a defined maturity and severity model.
  • Language and protocol-specific guidance spanning common framework conventions plus GraphQL, gRPC/protobuf, async/event, webhooks, and core contract headers.

Quick Start

Use this skill to review a proposed API or CLI change by asking your AI to identify blocking contract violations and recommend how to resolve them without implementing code.

Frequently Asked Questions about api-review

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

FAQPage Schema
How do I check if an API change is breaking before shipping?▼

Evaluate REST HTTP interface modifications against caller expectations to classify breaking versus non-breaking changes and receive actionable resolution directions for API contract safety.

What is the best way to standardize error response shapes in a REST API?▼

Enforce a uniform error envelope structure that maintains consistent HTTP status code semantics and reliable contract behavior for callers, standardizing REST API error response shapes.

How do I design pagination and authentication behavior for long-term API scalability?▼

Apply maturity and severity models to enforce correct idempotency semantics and documented versioning strategies, designing pagination and authentication behavior for long-term API scalability.

Does this API review process work with GraphQL, gRPC, and webhooks?▼

Providing language and protocol-specific guidance alongside core REST HTTP contract checks, this API review process works with GraphQL, gRPC/protobuf, async/event interfaces, and webhooks.

How do I enforce CLI conventions and naming normalization across interface changes?▼

Review proposed modifications to prevent inconsistent contract behavior and fragile caller interactions before deployment, enforcing CLI conventions and naming normalization across interface changes.

When do I need to evaluate HTTP verb selection and status code semantics?▼

Evaluate HTTP verb selection and status code semantics when modifying REST interfaces to ensure correct idempotency semantics and avoid breaking caller expectations in production environments.

Related Skills

Explore More Software Engineering Skills→
michaelsvanbeekmichaelsvanbeek
1

api-design

Define REST API design patterns and contract standards for endpoints and OpenAPI documentation.

Community
Advanced
vanman2024vanman2024
3

breaking-change-detection

Diff OpenAPI specs, SQL schemas, and contracts to classify breaking changes by severity.

Community
Advanced
MysMonMysMon
2

api-design

Design contract-first APIs with OpenAPI, GraphQL SDL, and Protobuf contracts.

Community
Advanced
hpsgdhpsgd

api-design

Design RESTful API contracts with resource models, HTTP methods, and error handling.

Official
Advanced