OpenAPI Specification Validator

Validates and lints OpenAPI 3.x specifications using swagger-parser, spectral, and openapi-typescript. Generates type-safe client SDKs and detects breaking API changes via oasdiff.

Prerequisites

swagger-parser, @stoplight/spectral, openapi-typescript, oasdiff, Redocly CLI

Installation

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

• npm install @apidevtools/swagger-parser
• git clone https://github.com/APIDevTools/swagger-parser.git
• npm install
• npm test

Requirements and caveats from upstream:

• Tested in Node.js and all modern web browsers on Mac, Windows, and Linux
• When using Swagger Parser in Node.js apps, you'll probably want to use CommonJS syntax:
• const SwaggerParser = require("@apidevtools/swagger-parser");

Basic usage or getting-started notes:

• Example

• Or use async/await or Promise syntax instead. The following example is the same as above:

• bash

• Source: https://github.com/APIDevTools/swagger-parser

• Extracted from upstream docs: https://raw.githubusercontent.com/APIDevTools/swagger-parser/HEAD/README.md

Documentation

• https://apidevtools.com/swagger-parser/docs/

Source

• Agent Skill Exchange