audit-api-consistency

Audit REST/GraphQL API endpoints and report consistency deviations with severity ratings.

6|Updated Feb 19, 2026
One-click install
npx skills add https://github.com/jerelvelarde/chalk-skills --skill audit-api-consistency-jerelvelarde
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: audit-api-consistency
Source: https://github.com/jerelvelarde/chalk-skills/tree/main/skills/audit-api-consistency
Command: npx skills add https://github.com/jerelvelarde/chalk-skills --skill audit-api-consistency-jerelvelarde

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Audit existing API endpoints for consistency across naming, HTTP methods, error response shapes, pagination, authentication patterns, and versioning to surface deviations and improve quality across the codebase. The aim is to provide a structured, severity-rated report that guides fixes and standardization.

Core Features & Use Cases

  • Inventory API endpoints across the codebase, capturing method, path, handler, and framework patterns.
  • Analyze endpoints against dominant conventions for URL naming, method usage, error responses, pagination, and auth.
  • Generate severity-rated findings with concrete remediation recommendations for developers and platform teams.

Quick Start

Run the audit-api-consistency skill on the target repository to generate a structured API consistency report.

Frequently Asked Questions about audit-api-consistency

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

FAQPage Schema
How do I audit API consistency and quality across multiple services?

API consistency auditing scans route registrations across a codebase to identify REST and GraphQL endpoint definitions, comparing them against dominant conventions for naming, HTTP methods, error shapes, pagination, and auth to surface deviations and generate a severity-rated remediation report.

What is the best way to find inconsistent API naming and error response patterns?

Finding inconsistent API patterns involves inventorying endpoints by capturing method, path, handler, and framework patterns, then analyzing them against shared conventions for error handling and versioning to surface deviations with severity ratings and concrete remediation recommendations.

Can I audit both REST and GraphQL endpoints for pattern deviations?

Yes, API consistency auditing applies to codebases with REST and GraphQL endpoints across multiple services, scanning route registrations to surface deviations in HTTP methods, pagination, authentication patterns, and versioning for a comprehensive consistency assessment.

How do I generate an API consistency report with severity ratings?

Generate an API consistency report by running an audit on the target repository to scan route registrations and consult shared conventions, producing a structured report with severity ratings and actionable remediation recommendations for developers and platform teams to guide fixes and standardization.

What does an API consistency audit check for besides URL naming conventions?

Beyond URL naming conventions, an API consistency audit evaluates HTTP method usage, error response shapes, pagination structures, authentication patterns, and versioning, assessing endpoint definitions against dominant codebase conventions to ensure comprehensive quality and standardization.