| 1 | # Swagger Client <img src="https://raw.githubusercontent.com/swagger-api/swagger.io/wordpress/images/assets/SW-logo-clr.png" height="50" align="right">
|
| 2 |
|
| 3 | [](https://jenkins.swagger.io/view/OSS%20-%20JavaScript/job/oss-swagger-js-master/)
|
| 4 |
|
| 5 | **Swagger Client** is a JavaScript module that allows you to fetch, resolve, and interact with Swagger/OpenAPI documents.
|
| 6 |
|
| 7 | ## New!
|
| 8 |
|
| 9 | **This is the new version of swagger-js, 3.x.** The new version supports Swagger 2.0 as well as OpenAPI 3.
|
| 10 |
|
| 11 | Want to learn more? Check out our [FAQ](docs/migration/migration-2-x-to-3-x.md).
|
| 12 |
|
| 13 | For features known to be missing from 3.x please see the [Graveyard](docs/migration/graveyard-3-x.md).
|
| 14 |
|
| 15 |
|
| 16 | For the older version of swagger-js, refer to the [*2.x branch*](https://github.com/swagger-api/swagger-js/tree/2.x).
|
| 17 |
|
| 18 | > *The npm package is called `swagger-client` and the GitHub repository is `swagger-js`.
|
| 19 | We'll be consolidating that soon. Just giving you the heads up. You may see references to both names.*
|
| 20 |
|
| 21 | ## Compatibility
|
| 22 | The OpenAPI Specification has undergone multiple revisions since initial creation in 2010.
|
| 23 | Compatibility between Swagger Client and the OpenAPI Specification is as follows:
|
| 24 |
|
| 25 | Swagger Client Version | Release Date | OpenAPI Spec compatibility | Notes
|
| 26 | ------------------ | ------------ | -------------------------- | -----
|
| 27 | 3.10.x | 2020-01-17 | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3 | [tag v3.10.0](https://github.com/swagger-api/swagger-js/tree/v3.10.0)
|
| 28 | 2.1.32 | 2017-01-12 | 1.0, 1.1, 1.2 | [tag v2.1.32](https://github.com/swagger-api/swagger-js/tree/v2.1.32). This [release](https://github.com/swagger-api/swagger-js/releases/tag/v2.1.32) is only available on GitHub.
|
| 29 |
|
| 30 | ## Documentation
|
| 31 |
|
| 32 | #### Usage
|
| 33 |
|
| 34 | - [Installation](docs/usage/installation.md)
|
| 35 | - [Tags Interface](docs/usage/tags-interface.md)
|
| 36 | - [TryItOut Executor](docs/usage/try-it-out-executor.md)
|
| 37 | - [OpenAPI Definition Resolver](docs/usage/openapi-definition-resolver.md)
|
| 38 | - [HTTP Client](docs/usage/http-client.md)
|
| 39 | - [Swagger Client API](docs/usage/api.md)
|
| 40 |
|
| 41 | #### Development
|
| 42 |
|
| 43 | - [Contributing](https://github.com/swagger-api/.github/blob/master/CONTRIBUTING.md)
|
| 44 | - [Setting up](docs/development/setting-up.md)
|
| 45 | - [Scripts](docs/development/scripts.md)
|
| 46 |
|
| 47 | #### Migrations
|
| 48 |
|
| 49 | - [Migration guide](docs/migration/migration-2-x-to-3-x.md)
|
| 50 | - [Graveyard](docs/migration/graveyard-3-x.md)
|
| 51 |
|
| 52 | ### Runtime
|
| 53 |
|
| 54 | - Node.js `>=` 10.x
|
| 55 | - `swagger-client` works in the latest versions of Chrome, Safari, Firefox, and Edge.
|
| 56 |
|
| 57 | ## Security contact
|
| 58 |
|
| 59 | Please disclose any security-related issues or vulnerabilities by emailing [security@swagger.io](mailto:security@swagger.io), instead of using the public issue tracker.
|