Spectral is an open source JSON/YAML linter, which allows you to create style guides for your structured data; things like OpenAPI/AsyncAPI/RAML descriptions, Kubernetes config, GitHub Actions, you name it, Spectral can help you lint it. Go beyond making sure they are “Technically Correct”, make sure they are useful.
Want to create and edit API descriptions with a visual editor instead of scratching YAML into a cave wall with a rock? Use Stoplight Studio, and let Spectral give you feedback in real-time.
API description formats like the OpenAPI Specification can be permissive and vague. Beginner API designers can struggle to know what to do, and experienced API designers can easily forget.
It’s easy to create valid description documents that are not very useful, and end up looking broken in documentation tools, or not provide enough validation keywords to be useful for contract testing.
Ask 100 API designers what makes a good API design and you’ll get 101 answers, but all most developers really want is consistency. Using a style guide can reduce decision making and improve consistency for all your teams.
You can use the default style guide, extend it, or create one to match your organization’s style guide.