@readme/openapi-schemas

This package contains the official JSON Schemas for every version of Swagger/OpenAPI Specification:

Version	Schema	Docs
Swagger 1.2	v1.2 schema	v1.2 docs
Swagger 2.0	v2.0 schema	v2.0 docs
OpenAPI 3.0.x	v3.0.x schema	v3.0.3 docs
OpenAPI 3.1.x	v3.1.x schema	v3.1.0 docs

Installation

You can install OpenAPI Schemas via npm.

1npm install @readme/openapi-schemas

Usage

The library contains all OpenAPI Specification versions:

1import { openapi } from '@readme/openapi-schemas';
2
3console.log(openapi.v1); // { $schema, id, properties, definitions, ... }
4console.log(openapi.v2); // { $schema, id, properties, definitions, ... }
5console.log(openapi.v3); // { $schema, id, properties, definitions, ... }
6console.log(openapi.v31); // { $schema, id, properties, definitions, ... }

You can use a JSON Schema validator such as Z-Schema or AJV to validate OpenAPI definitions against the specification.

1import { openapi } from '@readme/openapi-schemas';
2import ZSchema from 'z-schema';
3
4// Create a ZSchema validator
5let validator = new ZSchema();
6
7// Validate an OpenAPI definition against the OpenAPI v3.0 specification
8validator.validate(openapiDefinition, openapi.v31);