Validates OpenAPI and AsyncAPI specifications against enterprise standards and Zalando RESTful API guidelines.
The api.validate skill provides a robust framework for ensuring your API definitions meet professional enterprise standards. It automates the inspection of OpenAPI and AsyncAPI specifications, checking for compliance with the Zalando RESTful API Guidelines to catch common design mistakes, naming inconsistencies, and missing metadata. By offering both human-readable reports for developers and JSON output for automation, it serves as a critical quality gate that can be integrated directly into local development hooks or CI/CD pipelines to maintain high-quality API design across the entire development lifecycle.
Key Features
01Strict mode support for zero-tolerance CI/CD enforcement
02Integration with file-edit and commit hooks for real-time feedback
03Built-in compliance checking for Zalando RESTful API Guidelines
040 GitHub stars
05Comprehensive validation for OpenAPI 3.x and AsyncAPI 3.x
06Human-readable and JSON output formats for versatile reporting
Use Cases
01Enforcing consistent naming conventions and error schemas across microservices
02Identifying missing mandatory enterprise metadata like x-api-id and contact info
03Automating API specification linting within pre-commit hooks and build pipelines
