Swagger Client

Swagger Clientis 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 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-clientand the GitHub repository isswagger-js. We'll be consolidating that soon. Just giving you the heads-up. You may see references to both names.

Compatibility

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 Version	Release Date	OpenAPI Spec compatibility	Notes
3.19.x	2023-01-23	2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.1.0	tag v3.19.0- Alpha.3
3.10.x	2020-01-17	2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3	tag v3.10.0
2.1.32	2017-01-12	1.0, 1.1, 1.2	tag v2.1.32.Thisreleaseis only available on GitHub.

Documentation

Usage

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

Development

• Contributing
• Setting up
• Scripts

Migrations

• Migration guide
• Graveyard

Runtime

Node.js

swagger-clientrequires Node.js>=12.20.0and uses differentfetchimplementation depending on 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 Releases which means that we can drop support forEOL(End Of Life) Node.js versions without doing major version bump.

Browsers

swagger-clientworks in the latest versions of Chrome, Safari, Firefox, and Edge and usesnative fetchimplementation provided by each supported browser.

Security contact

Please disclose any security-related issues or vulnerabilities by emailing[email protected],instead of using the public issue tracker.