OpenAPI Spec Linter & Docs Generator

Validates OpenAPI 3.x specifications using Spectral rulesets and generates interactive API documentation with Redoc and Swagger UI. Detects breaking changes using oasdiff for versioned APIs.

Installation

Use the upstream install or setup path that matches your environment:

• npm install -g @stoplight/spectral-cli
• yarn global add @stoplight/spectral-cli

Basic usage or getting-started notes:

• 💻 Usage

• 💻 Usage

• To get started, run this command in your terminal to create a .spectral.yaml file that uses the Spectral predefined rulesets based on OpenAPI, Arazzo or AsyncAPI:

• Source: https://github.com/stoplightio/spectral

• Extracted from upstream docs: https://raw.githubusercontent.com/stoplightio/spectral/HEAD/README.md

Documentation

• https://docs.stoplight.io/docs/spectral/ZG9jOjExNw-overview

Source

• Agent Skill Exchange