Openapi Spec Linter Docs Generator

---
name: "OpenAPI Spec Linter & Docs Generator"
slug: "openapi-spec-linter-docs-generator"
description: "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."
github_stars: 3084
verification: "security_reviewed"
source: "https://github.com/stoplightio/spectral"
author: "Stoplight"
category: "Library & API Reference"
framework: "Claude Agents"
tool_ecosystem:
  github_repo: "stoplightio/spectral"
  github_stars: 3084
  npm_package: "@stoplight/spectral-cli"
  npm_weekly_downloads: 1201267
---

# 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)
- ## 💻 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](https://agentskillexchange.com/skills/openapi-spec-linter-docs-generator/)