Spectral is a flexible JSON/YAML linter for creating automated style guides, with baked in support for OpenAPI (v3.1, v3.0, and v2.0), Arazzo v1.0, as well as AsyncAPI v2.x.
Spectral, being a generic YAML/JSON linter, needs a ruleset to lint files. A ruleset is a JSON, YAML, or JavaScript/TypeScript file (often the file is called .spectral.yaml for a YAML ruleset) that contains a collection of rules, which can be used to lint other JSON or YAML files such as an API description.
Linting isn’t just about validating OpenAPI or JSON Schema documents against specifications. It’s for enforcing style guides to ensure that your APIs are consistent, valid, and of high quality.
This is free and open source software.
Key Features
- Custom Rulesets: Create custom rules to lint JSON or YAML objects.
- Ready-to-use Rulesets: Validate and lint OpenAPI v2 & v3.x, AsyncAPI, and Arazzo v1 Documents.
- API Style Guides: Automated API Style Guides using rulesets improve consistency across all your APIs.
- Ready-to-use Functions: Built-in set of functions to help create custom rules. Functions include pattern checks, parameter checks, alphabetical ordering, a specified number of characters, provided keys are present in an object, etc.
- Custom Functions: Create custom functions for advanced use cases.
Website: github.com/stoplightio/spectral
Support:
Developer: Stoplight
License: Apache License 2.0
Spectral is written in TypeScript. Learn TypeScript with our recommended free books and free tutorials.
Related Software
| OpenAPI Linters | |
|---|---|
| Spectral | Fexible JSON/YAML linter |
| vacuum | OpenAPI and Swagger linter |
| Redocly | All-in-one OpenAPI utility |
| Cherrybomb | Audit, validate, run API tests |
| Zally | Minimalistic, simple-to-use API linter |
| oasdiff | Validate OpenAPI specifications and detect breaking changes |
| Rate My OpenAPI | Improve the quality of your OpenAPI specifications |
| OpenAPI Validator | Configurable and extensible validator/linter |
| OpenAPI Spec validator | Validates OpenAPI Specs |
Read our verdict in the software roundup.
 LinuxLinks helps you discover the best free and open source software for Linux. Explore our extensive collection of recommended applications, including alternatives to popular proprietary software.We also publish software reviews, Linux tutorials, hardware reviews, free programming books and articles covering the wider open source community. Browse our Linux resources to discover more. Know a useful free and open source Linux application we haven't covered? Suggest a program for inclusion. Has your software been featured on LinuxLinks? Display one of our Featured on LinuxLinks badges on your website or GitHub README. |
Please read our Comment Policy before commenting.