Package Exports

oas-normalize

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (oas-normalize) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Swagger 2 or OAS 3? YAML or JSON? URL, path, string or object? Who cares! It just works.

This module uses a bunch of other great modules to do the heavy lifting, and normalizes everything!

Install

npm install oas-normalize --save

Usage

It's pretty simple:

const OASNormalize = require('oas-normalize');

const oas = new OASNormalize('https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore-expanded.yaml'); // Or a string, pathname, JSON blob, whatever

oas.validate().then(definition => {
  console.log(definition); // definition will always be JSON, and valid
}).catch(err => {
  console.log(err.errors);
});

Errors

For validation errors, when available, you'll get back an object:

{
  "errors": [
    {
      "message": "User-friendly message",
      "path": [...array of the path to the error...]
    }
  ],
  "full": ...raw errors...
}

message is almost always there, but path is less dependable.

Helper functions

Note: All of these functions are promise-driven.

If you want some more functionality, you can do anything here:

Function	What it does
`.load()`	Just load the file, valid or not, as JSON
`.bundle()`	Bring together all files into one JSON blob (but retain `$ref` pointers)
`.deref()`	Resolve `$ref` pointers
`.validate([convertToLatest?])`	Validate the whole thing!

Other little features

Always return OAS 3

If you want .validate to always return an OpenAPI 3.0 definition, supply true as its argument:

OASNormalize.validate(true).then(...);

Enable local paths

For security reasons, you need to enable it; supply enablePaths to the class instance:

const oas = new OASNormalize('./petstore.json', { enablePaths: true })