Skip to content
JSON Schemas for every version of the OpenAPI Specification
Branch: master
Clone or download
Latest commit 2e778d1 Jun 22, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode Added basic tooling files Jun 22, 2019
src Added the code to export the schemas as CommonJS and ESM exports Jun 22, 2019
test Added tests to check for updated schemas Jun 22, 2019
.editorconfig Added basic tooling files Jun 22, 2019
.gitattributes Added basic tooling files Jun 22, 2019
.gitignore Added basic tooling files Jun 22, 2019
.mocharc.yml Setup testing scaffolding Jun 22, 2019
.nycrc.yml Setup testing scaffolding Jun 22, 2019
.travis.yml Setup CI/CD Jun 22, 2019
404.md
LICENSE Added basic tooling files Jun 22, 2019
README.md Added badges, description, instructions, and usage examples Jun 22, 2019
_config.yml
package-lock.json release v1.0.0 Jun 22, 2019
package.json release v1.0.0 Jun 22, 2019
tsconfig.json Setup TypeScript configs Jun 22, 2019
tslint.yaml Setup TypeScript configs Jun 22, 2019

README.md

OpenAPI Specification Schemas

Cross-Platform Compatibility Build Status

Coverage Status Dependencies

npm License

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

All schemas are kept up-to-date with the latest official definitions via an automated CI/CD job. 🤖📦

Installation

You can install openapi-schemas via npm.

npm install openapi-schemas

Usage

The default export contains all OpenAPI Specification versions:

const openapi = require("openapi-schemas");

console.log(openapi.v1);    // { $schema, id, properties, definitions, ... }
console.log(openapi.v2);    // { $schema, id, properties, definitions, ... }
console.log(openapi.v3);    // { $schema, id, properties, definitions, ... }

Or you can import the specific version(s) that you need:

const { openapiV1, openapiV2, openapiV3 } = require("openapi-schemas");

console.log(openapiV1);    // { $schema, id, properties, definitions, ... }
console.log(openapiV2);    // { $schema, id, properties, definitions, ... }
console.log(openapiV3);    // { $schema, id, properties, definitions, ... }

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

const { openapiV3 } = require("openapi-schemas");
const ZSchema = require("z-schema");

// Create a ZSchema validator
let validator = new ZSchema();

// Validate an OpenAPI definition against the OpenAPI v3.0 specification
validator.validate(openapiDefinition, openapiV3);

Contributing

Contributions, enhancements, and bug-fixes are welcome! File an issue on GitHub and submit a pull request.

Building

To build the project locally on your computer:

  1. Clone this repo
    git clone https://github.com/APIDevTools/openapi-schemas.git

  2. Install dependencies
    npm install

  3. Build the code
    npm run build

  4. Run the tests
    npm test

License

openapi-schemas is 100% free and open-source, under the MIT license. Use it however you want.

Big Thanks To

Thanks to these awesome companies for their support of Open Source developers ❤

Travis CI SauceLabs Coveralls

You can’t perform that action at this time.