Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,19 @@

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

## Table of Contents
- [New](#new)
- [Compatibility](#compatibility)
- [Anonymized analytics](#anonymized-analytics)
- [Documentation](#documentation)
- [Usage](#usage)
- [Development](#development)
- [Migrations](#migrations)
- [Runtime](#runtime)
- [Node js](#nodejs)
- [Browsers](#browsers)
- [Security Contact](#security-contact)

## New!

**This is the new version of swagger-js, 3.x.** The new version supports Swagger 2.0 as well as OpenAPI 3.
Expand Down Expand Up @@ -68,9 +81,9 @@ Alternatively, you can set the environment variable `SCARF_ANALYTICS` to `false`
- [Migration guide](docs/migration/migration-2-x-to-3-x.md)
- [Graveyard](docs/migration/graveyard-3-x.md)

### Runtime
## Runtime

### Node.js
#### Node.js

`swagger-client` requires Node.js `>=12.20.0` and uses different `fetch` implementation depending
on Node.js version.
Expand All @@ -81,7 +94,7 @@ on Node.js version.
> NOTE: swagger-client minimum Node.js runtime version aligns with [Node.js Releases](https://nodejs.org/en/about/releases/)
> which means that we can drop support for **EOL** (End Of Life) Node.js versions without doing major version bump.

### Browsers
#### Browsers

`swagger-client` works in the latest versions of Chrome, Safari, Firefox, and Edge
and uses [native fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) implementation
Expand Down