validating-api-schemas
SKILL.md
Validating API Schemas
Overview
Validate API specifications against OpenAPI 3.0/3.1, JSON Schema Draft 2020-12, and GraphQL SDL standards using linting rules, structural analysis, and best-practice enforcement. Detect incomplete schemas, undocumented endpoints, inconsistent naming conventions, and breaking changes before they reach consumers.
Prerequisites
- OpenAPI specification files (YAML or JSON) or GraphQL SDL schema files
- Schema linting tool: Spectral (OpenAPI),
graphql-schema-linter(GraphQL), orajv-cli(JSON Schema) - Version control for schema files to enable diff-based breaking change detection
- CI pipeline for automated schema validation on every pull request
oasdifforopenapi-difffor breaking change detection between versions