Package Exports

openapi-resolver
openapi-resolver/dist/openapi-resolver.browser
openapi-resolver/dist/openapi-resolver.browser.js
openapi-resolver/es/index.js
openapi-resolver/lib/commonjs.js

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 (openapi-resolver) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

OpenAPI Resolver

OpenAPI Resolver is a JavaScript module that allows you to fetch, resolve, and interact with Swagger/OpenAPI documents.

New!

This is the new version of swagger-js, 3.x. The OpenAPI Resolver replaces swagger-js.

Compatibility

The OpenAPI Specification has undergone multiple revisions since initial creation in 2010. Compatibility between OpenAPI Resolver and the OpenAPI Specification is as follows:

OpenAPI Resolver Version	Release Date	OpenAPI Spec compatibility	Notes
4.x	2022-07-24	2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.1.0
3.10.x	2020-01-17	2.0, 3.0.0

Installation

We publish single module to npm: openapi-resolver. openapi-resolver is meant for consumption by any JavaScript engine (node.js, browser, etc...). The npm package contains transpiled and minified ES5 compatible code.

 $ npm install openapi-resolver

After installed successfully:

ES6 imports

import openApiResolver from 'openapi-resolver';

CommonJS imports

const openApiResolver = require('openapi-resolver');

Usage

import openApiResolver from 'openapi-resolver';

const spec = await openApiResolver('http://petstore.swagger.io/v2/swagger.json');

Runtime

Node.js: lts
openapi-resolver works in the latest versions of Chrome, Safari, Firefox, and Edge.

Security contact

Please disclose any security-related issues or vulnerabilities by emailing security@authress.io, instead of using the public issue tracker.