spectral-linting

Lint OpenAPI specs with Spectral using a .spectral.yml configuration.

6|Updated Feb 20, 2025
One-click install
npx skills add https://github.com/zerobias-org/module --skill spectral-linting
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: spectral-linting
Source: https://github.com/zerobias-org/module/tree/main/.claude/skills/spectral-linting
Command: npx skills add https://github.com/zerobias-org/module --skill spectral-linting

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

OpenAPI specs often drift or contain errors that slip into production, causing integration issues and slow down development. This Skill provides a standardized Spectral-based linting setup to catch common OpenAPI mistakes before merge and promote consistent API documentation.

Core Features & Use Cases

  • Standard OpenAPI linting setup using Spectral with a recommended baseline (.spectral.yml) for critical and warning rules.
  • CI-friendly guidance to automatically lint specs in pull requests and pipelines.
  • Enforces key quality checks (operationId presence, 2xx responses, tag definitions, and valid schemas) to reduce regressions.

Quick Start

Install Spectral and run lint on your OpenAPI spec using the spectral-cli tool.

Frequently Asked Questions about spectral-linting

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I lint OpenAPI specs to enforce API quality in CI pipelines?

You can lint OpenAPI specs in CI pipelines using Spectral to catch API errors before merge and promote consistent API documentation across projects. This setup requires a .spectral.yml configuration file and a basic OpenAPI document to begin automated linting.

What OpenAPI errors does Spectral linting catch before production?

Spectral linting catches common OpenAPI drift and errors before production, enforcing checks like operationId presence, 2xx responses, tag definitions, and valid schemas to reduce integration issues and regressions.

What do I need to start linting an OpenAPI document with Spectral?

To start linting an OpenAPI document with Spectral, you need a .spectral.yml file in your project root and a basic OpenAPI document. You then install Spectral and run the lint using the spectral-cli tool.

Can I use Spectral to automatically lint OpenAPI specs in pull requests?

Yes, you can use Spectral to automatically lint OpenAPI specs in pull requests. This Skill provides CI-friendly guidance to integrate Spectral into your pipelines, ensuring API quality checks run automatically before merges.

Why should I use Spectral for OpenAPI linting instead of other category-level tools?

Spectral provides a standardized linting setup with a recommended baseline configuration for critical and warning rules, specifically designed to prevent OpenAPI spec drift and catch integration issues early in development.

Does Spectral support a ready-made configuration for onboarding new API teams?

Yes, Spectral supports a ready-made configuration with a recommended baseline for critical and warning rules, providing clear guidance specifically designed to onboard new API teams and enforce consistent quality checks.