Repository files navigation

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

This is the new version of swagger-js, 3.x. The new version supports Swagger 2.0 as well as OpenAPI 3.

Want to learn more? Check out ourFAQ.

For features known to be missing from 3.x please see theGraveyard.

For the older version of swagger-js, refer to the2.x branch.

The npm package is calledswagger-client and the GitHub repository isswagger-js.We'll be consolidating that soon. Just giving you the heads-up. You may see references to both names.

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

Swagger Client usesScarf to collectanonymized installation analytics. These analytics help support the maintainers of this library and ONLY run during installation. Toopt out, you can set thescarfSettings.enabled field tofalse in your project'spackage.json:

// package.json{  // ...  "scarfSettings": {    "enabled": false  }  // ...}

Alternatively, you can set the environment variableSCARF_ANALYTICS tofalse as part of the environment that installs your npm packages, e.g.,SCARF_ANALYTICS=false npm install.

• Installation
• Tags Interface
• HTTP client for OAS operations
• OpenAPI Definition Resolver
• HTTP Client
• Swagger Client API

• Contributing
• Setting up
• Scripts

• Migration guide
• Graveyard

swagger-client requires Node.js>=12.20.0 and uses differentfetch implementation dependingon Node.js version.

• >=12.20.0 <18 -node-fetch@3
• >=18 -native Node.js fetch

NOTE: swagger-client minimum Node.js runtime version aligns withNode.js Releaseswhich means that we can drop support forEOL (End Of Life) Node.js versions without doing major version bump.

swagger-client works in the latest versions of Chrome, Safari, Firefox, and Edgeand usesnative fetch implementationprovided by each supported browser.

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