Skip to content

Repository files navigation

Authress media banner

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 VersionRelease DateOpenAPI Spec compatibilityNotes
4.x2022-07-242.0, 3.0, 3.1, 3.2
3.10.x2020-01-172.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

importopenApiResolverfrom'openapi-resolver';

CommonJS imports

constopenApiResolver=require('openapi-resolver');

Usage

importopenApiResolverfrom'openapi-resolver';constspec=awaitopenApiResolver('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.

About

Javascript library to connect to parse and resolve openapi-enabled APIs via browser or nodejs

Resources

Security policy

Stars

5 stars

Watchers

1 watching

Forks

Releases

Used by

Contributors

Languages