🌜
🌞
swagger-client

swagger-client

v3.18.5

SwaggerJS - a collection of interfaces for OAI specs

npm install swagger-client

README

Swagger Client

Build Status

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

Development

Migrations

Runtime

  • Node.js >= 12.4.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.

Release Notes

3.18.5
By Swagger-Bot • Published on May 6, 2022

3.18.5 (2022-05-06)

Bug Fixes

  • use isomorphic solution for base64 encoding (#2526) (4832f32)
3.18.4
By Swagger-Bot • Published on February 2, 2022

3.18.4 (2022-02-02)

Bug Fixes

3.18.3
By Swagger-Bot • Published on January 25, 2022

3.18.3 (2022-01-25)

Bug Fixes

3.18.2
By Swagger-Bot • Published on January 19, 2022

3.18.2 (2022-01-19)

Bug Fixes

  • normalizeSwagger: fix regression in swagger normalization (1f9db2b)
3.18.1
By Swagger-Bot • Published on January 14, 2022

3.18.1 (2022-01-14)

Bug Fixes

  • specmap: fix deep merging when applying patch (#2324) (65fcd22)
3.18.0
By Swagger-Bot • Published on December 21, 2021

3.18.0 (2021-12-21)

Features

  • add support aborting requests in tags interface (7b6bdc2), closes #2349
3.17.0
By Swagger-Bot • Published on October 14, 2021

3.17.0 (2021-10-14)

Features

Other changes

  • replace lodash utils with native JavaScript alternatives (1556f58ccb0d3d266e8be8963501d8d1e55e2014, e3d4ef339ad107aaed9b14a8ba8ee635574b5199, af2b86cf9c7552b3e9d00659522bd4ca91dd489e)
  • replace Buffer.isBuffer with ArrayBuffer.isView (eae9bbce88c5e9c8c22c78bd9fa2ec32f3cb3bdf)
3.16.1
By Swagger-Bot • Published on September 10, 2021

3.16.1 (2021-09-10)

Bug Fixes

  • security: depend on min version of lodash >= 4.17.21 (374ef79)
3.16.0
By Swagger-Bot • Published on August 20, 2021

3.16.0 (2021-08-20)

Features

  • deps: bump formdata-node from 3.7.0 to 4.0.0 (#2196) (3da4ae8)
  • formdata: add compatibility layer that transforms Buffers into Blobs
3.15.0
By Swagger-Bot • Published on August 9, 2021

3.15.0 (2021-08-09)

Features

  • deps: bump js-yaml from 3.14.1 to 4.1.0 (3937607), closes #2026 #1970
  • build: unify how we use cross-fetch to reduce resulting bundle size (1e8839c)

General

License
Apache-2.0
Typescript Types
None found
Tree-shakeable
Yes

Popularity

GitHub Stargazers
2,411
Community Interest
3,230
Number of Forks
740

Maintenance

Commits
10/219/22050
Last Commit
Open Issues
40
Closed Issues
772
Open Pull Requests
5
Closed Pull Requests
275

Versions

Versions Released
10/219/2203
Latest Version Released
May 6, 2022
Current Tags
latest3.18.5

Contributors

fehguy
fehguy
Commits: 714
shockey
shockey
Commits: 296
char0n
char0n
Commits: 153
ponelat
ponelat
Commits: 77
swaggerhub-bot
swaggerhub-bot
Commits: 29
zeke
zeke
Commits: 29
webron
webron
Commits: 24
whitlockjc
whitlockjc
Commits: 22
buunguyen
buunguyen
Commits: 20
owenconti
owenconti
Commits: 19
ayush
ayush
Commits: 18
xoss
xoss
Commits: 12
bodnia
bodnia
Commits: 11
swagger-bot
swagger-bot
Commits: 10
semantic-release-bot
semantic-release-bot
Commits: 10