stoplightio/spectral
Spectral
Spectral is a programmable linting engine and validation tool designed to enforce style guidelines and schema correctness within OpenAPI specifications and JSON configuration files. It functions as a rule-based validator that analyzes structured text files to ensure data consistency and adherence to predefined constraints.
The engine utilizes a configuration-driven execution model, allowing users to manage pluggable rule sets and integrate JSON Schema definitions. It supports the creation of custom function-based rules to define complex validation logic beyond static declarations.
The project provides tools for API design governance and documentation quality, automating the verification of OpenAPI and JSON/YAML documents. It employs rule-based abstract syntax tree validation and systematic document traversal to identify and report violations.
Features
- API Governance Toolkits - Provides a toolkit for enforcing consistent style guidelines across multiple API definitions.
- JSON-Schema - Integrates standardized JSON Schema definitions to enforce data types and required fields within documents.
- OpenAPI Specification Linters - Checks OpenAPI documents for consistency and correctness to ensure they follow standard design rules.
- Linters - Provides a utility to validate JSON and YAML documents against predefined or custom rules to ensure consistency.
- AST Validation - Employs rule-based abstract syntax tree validation to identify and report structural violations in documents.
- JSON Schema Validation - Automates the verification of structured JSON and YAML files to ensure adherence to schemas and prevent errors.
- Linting Engines - Functions as a programmable linting engine that analyzes structured text files using declarative patterns.
- API Documentation Linting - Improves API documentation quality by catching missing descriptions or incorrect formats during development.
- AST Visitor Patterns - Utilizes the visitor design pattern to systematically traverse the document hierarchy and report violations.
- Custom Validation Functions - Allows the use of external JavaScript functions to define complex validation logic beyond static declarations.
- Configuration-Driven Rules - Uses local configuration files to determine which validation rules to apply and how to report errors.
- Linting Rule Configurations - Provides a system for defining custom linting rule configurations to maintain standardization across files.
- Pluggable Rule Sets - Supports modular collections of validation constraints that can be toggled or extended through configuration files.
- API Design Tools - Linter for detecting errors in JSON and YAML API files.
- API Specification Tools - Lints YAML or JSON files against custom rulesets.
