isabella232 / swagger-js

Javascript library to connect to swagger-enabled APIs via browser or nodejs

Swagger Client

Swagger Client 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 new version supports Swagger 2.0 as well as OpenAPI 3.

Want to learn more? Check out our FAQ.

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

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

The npm package is called swagger-client and the GitHub repository is swagger-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.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. This release is only available on GitHub.

Documentation

Usage

• Installation
• Tags Interface
• TryItOut Executor
• OpenAPI Definition Resolver
• HTTP Client
• Swagger Client API

Development

• Contributing
• Setting up
• Scripts

Migrations

• Migration guide
• Graveyard

Runtime

• Node.js >= 10.x
• swagger-client works in the latest versions of Chrome, Safari, Firefox, and Edge.

Security contact

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