andrewsomething / spectral-rules

Collecting examples of Spectral rulesets and functions in the wild

Extending Spectral

Spectral is a JSON/YAML linter, with out of the box support for OpenAPI v2/v3 and AsyncAPI v2. It is becoming increasingly popular as a tool for defining API style guides that can be used in reviews and automation. It is very extensible, allowing users to both create custom rulesets using builtin functions and write custom rules in JavaScript. This repository is collecting examples of Spectral rulesets and functions in the wild.

Stoplight Spectral Documentation

• Custom Rulesets
• Custom Functions
• Sharing & Distributing Rulesets
• Core Functions

Custom Rulesets and Functions

• OpenAPI Community Style Guide
  • Collection of custom rulesets including APIs You Won't Hate, ruleset of "super opinionated HTTP API advice".
• Nexmo
  • .spectral.yml
  • functions
• Box
  • .spectral.yml
  • functions
• DigitalOcean
  • ruleset.yml
  • functions
• Azure
  • spectral.yaml
  • functions
• Using Spectral in Postman
  • Collection of more than 250 individual Spectral rules shared via Postman Open Technologies - Governance Rules and linting rules

Blog Posts

• Custom OpenAPI Style Rules with Spectral by Lorna Jane Mitchell
• Test Driven Development for Your Spectral Rules, using Jest by Jamie Tanna
• Use Spectral as OAS linter in your Web API development lifecycle by Melvin Lee

Talks

• The Augmented API Design Reviewer (slides) by Arnaud Lauret at the API Specifications Conference 2020