api-audit

name	api-audit
compatibility	["github-copilot-cli"]
description	Audits API endpoint designs, contracts, versioning strategies, and error handling. USE FOR: reviewing API endpoint definitions, validating request/response contracts, assessing error handling patterns, evaluating versioning strategies, analyzing documentation completeness. DO NOT USE FOR: implementing API endpoints, writing backend code, database design, frontend development, infrastructure setup.
category	operations
metadata	{"category":"operations","maturity":"stable","audience":["developer"]}
allowed-tools	[]

API Audit Skill

Comprehensive auditing of API designs, contracts, error handling strategies, versioning approaches, and integration patterns.

USE FOR

• Reviewing API endpoint definitions and route structures
• Validating request and response contracts (OpenAPI, schemas)
• Assessing HTTP status code usage and error handling patterns
• Evaluating API versioning strategies and deprecation practices
• Analyzing documentation completeness and accuracy
• Reviewing authentication and authorization patterns
• Assessing rate limiting, throttling, and quota strategies
• Evaluating consistency across API endpoints
• Identifying breaking changes and integration risks
• Creating structured audit findings with recommendations

DO NOT USE FOR

• Implementing API endpoints (use api-design or backend-dev skills)
• Writing backend code
• Database schema design
• Frontend development or client implementation
• Infrastructure provisioning
• General code review (use code-review skill)

Audit Checklist

• Endpoint Design: Naming conventions, HTTP verbs, parameter placement
• Contracts: Request/response schemas, type definitions, examples
• Error Handling: Status codes, error responses, failure scenarios
• Versioning: Strategy, deprecation policy, migration path
• Documentation: Completeness, accuracy, usability
• Security: Authentication, authorization, data protection
• Performance: Caching headers, pagination, filtering
• Consistency: Patterns, naming, response structure uniformity
• Integration: Backwards compatibility, changelog, client guidance

Related Skills

• api-design — Designing new API contracts and endpoints
• backend-audit — Reviewing backend implementation quality
• api-security — Security-focused API assessment
• contract-testing — Contract testing and verification