library swagger-ui {🖫 479,762, ⚐ 225, ★ 12,291}

swagger-api/swagger-ui

Swagger UI is a collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.

Saturday, July 28, 2018
by swagger
Repository
613 Watchers
12291 Stars
479,762 Installations

JavaScript
18 Dependents
0 Suggesters
5766 Forks
250 Open issues
100 Versions
32 % Grown

The README.md

total GitHub contributors , _(*1)

monthly npm installs total docker pulls monthly packagist installs gzip size , _(*2)

Introduction

Swagger UI allows anyone — be it your development team or your end consumers — to visualize and interact with the API’s resources without having any of the implementation logic in place. It’s automatically generated from your OpenAPI (formerly known as Swagger) Specification, with the visual documentation making it easy for back end implementation and client side consumption., _(*3)

General

👉🏼 Want to score an easy open-source contribution? Check out our Good first issue label., _(*4)

🕰️ Looking for the older version of Swagger UI? Refer to the 2.x branch., _(*5)

This repository publishes three different NPM modules:, _(*6)

swagger-ui is a traditional npm module intended for use in single-page applications that are capable of resolving dependencies (via Webpack, Browserify, etc.).
swagger-ui-dist is a dependency-free module that includes everything you need to serve Swagger UI in a server-side project, or a single-page application that can't resolve npm module dependencies.
swagger-ui-react is Swagger UI packaged as a React component for use in React applications.

We strongly suggest that you use swagger-ui instead of swagger-ui-dist if you're building a single-page application, since swagger-ui-dist is significantly larger., _(*7)

If you are looking for plain ol' HTML/JS/CSS, download the latest release and copy the contents of the /dist folder to your server., _(*8)

Compatibility

The OpenAPI Specification has undergone 5 revisions since initial creation in 2010. Compatibility between Swagger UI and the OpenAPI Specification is as follows:, _(*9)

Swagger UI Version	Release Date	OpenAPI Spec compatibility	Notes
5.0.0	2023-06-12	2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.1.0	tag v5.0.0
4.0.0	2021-11-03	2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3	tag v4.0.0
3.18.3	2018-08-03	2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3	tag v3.18.3
3.0.21	2017-07-26	2.0	tag v3.0.21
2.2.10	2017-01-04	1.1, 1.2, 2.0	tag v2.2.10
2.1.5	2016-07-20	1.1, 1.2, 2.0	tag v2.1.5
2.0.24	2014-09-12	1.1, 1.2	tag v2.0.24
1.0.13	2013-03-08	1.1, 1.2	tag v1.0.13
1.0.1	2011-10-11	1.0, 1.1	tag v1.0.1

Anonymized analytics

SwaggerUI uses Scarf to collect anonymized installation analytics. These analytics help support the maintainers of this library and ONLY run during installation. To opt out, you can set the scarfSettings.enabled field to false in your project's package.json:, _(*10)

// package.json
{
  // ...
  "scarfSettings": {
    "enabled": false
  }
  // ...
}

Alternatively, you can set the environment variable SCARF_ANALYTICS to false as part of the environment that installs your npm packages, e.g., SCARF_ANALYTICS=false npm install., _(*11)

Documentation

Usage

Customization

Development

Contributing

Contributing

Integration Tests

You will need JDK of version 7 or higher as instructed here https://nightwatchjs.org/guide/getting-started/installation.html#install-selenium-server, _(*12)

Integration tests can be run locally with npm run e2e - be sure you aren't running a dev server when testing!, _(*13)

Browser support

Swagger UI works in the latest versions of Chrome, Safari, Firefox, and Edge., _(*14)

Known Issues

To help with the migration, here are the currently known issues with 3.X. This list will update regularly, and will not include features that were not implemented in previous versions., _(*15)

Only part of the parameters previously supported are available.
The JSON Form Editor is not implemented.
Support for collectionFormat is partial.
l10n (translations) is not implemented.
Relative path support for external files is not implemented.

Security contact

Please disclose any security-related issues or vulnerabilities by emailing security@swagger.io, instead of using the public issue tracker., _(*16)

License

SwaggerUI is licensed under Apache 2.0 license. SwaggerUI comes with an explicit NOTICE file containing additional legal notices and information., _(*17)

The Versions

28/07 2018

dev-master

9999999-dev http://swagger.io

Swagger UI is a collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.

library swagger-ui

Swagger UI is a collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.

swagger-api/swagger-ui

The README.md

Introduction

General

Compatibility

Anonymized analytics

Documentation

Usage

Customization

Development

Contributing

Integration Tests

Browser support

Known Issues

Security contact

License

The Versions

dev-master

by Tony Tam

by Mohsen Azimi

by Anna Bodnia

by Buu Nguyen

by Josh Ponelat

by Kyle Shockey

by Robert Barnwell

by Sahar Jafari

v3.17.6

by Anna Bodnia

by Buu Nguyen

by Josh Ponelat

by Kyle Shockey

by Robert Barnwell

by Sahar Jafari

dev-v/3.17.6

by Anna Bodnia

by Buu Nguyen

by Josh Ponelat

by Kyle Shockey

by Robert Barnwell

by Sahar Jafari

dev-bug/4756

by Anna Bodnia

by Buu Nguyen

by Josh Ponelat

by Kyle Shockey

by Robert Barnwell

by Sahar Jafari

dev-v/3.17.5

by Anna Bodnia

by Buu Nguyen

by Josh Ponelat

by Kyle Shockey

by Robert Barnwell

by Sahar Jafari

v3.17.5

by Anna Bodnia

by Buu Nguyen

by Josh Ponelat

by Kyle Shockey

by Robert Barnwell

by Sahar Jafari

dev-housekeeping/size

by Anna Bodnia

by Buu Nguyen

by Josh Ponelat

by Kyle Shockey

by Robert Barnwell

by Sahar Jafari

dev-JonathansBranch

by Anna Bodnia

by Buu Nguyen

by Josh Ponelat

by Kyle Shockey

by Robert Barnwell

by Sahar Jafari

dev-revert-4728-master

by Anna Bodnia

by Buu Nguyen