You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Tyler Chen 36935c2310 feat: change logo and swap post/put color (#1) 9 months ago
.github ci(GA): add lint-errors step (#6564) 11 months ago
config feat: migrate unit tests to Jest (#6353) 1 year ago
dev-helpers refactor(csp): Update how the JavaScript run function is invoked in oauth2-redirect.html (#6393) 1 year ago
dist feat: change logo and swap post/put color (#1) 9 months ago
docker security(docker): hide nginx version (#6617) 10 months ago
docs Improve documentation for Standalone plain HTML installation (#6605) 10 months ago
flavors/swagger-ui-react feat(swagger-ui-react): add support for layout prop (#6639) 10 months ago
release refactor(release-it): update command substitution syntax (#6314) 1 year ago
src feat: change logo and swap post/put color (#1) 9 months ago
swagger-ui-dist-package Maintain backwards compatibility with absolutePath 4 years ago
test fix(examples): properly update memoized value in non-schema case (#6641) 10 months ago
webpack chore(deps-dev): css-loader cumulative deps and config update (#6596) 10 months ago
.agignore add .aignore 3 years ago
.commitlintrc.json chore: enforce commit message conventions (#6577) 11 months ago
.dockerignore feature: full-spectrum runtime Docker configuration (via #4965) 2 years ago
.editorconfig Create .editorconfig 4 years ago
.eslintignore chore: Do not run eslint in dist folders (#6413) 1 year ago
.eslintrc feat: migrate unit tests to Jest (#6353) 1 year ago
.gitattributes Set EOL of docker-run.sh to LF 4 years ago
.gitignore chore: update .gitignore with dev-helpers/examples (#6373) 1 year ago
.huskyrc chore: enforce commit message conventions (#6577) 11 months ago
.lintstagedrc chore: enforce commit message conventions (#6577) 11 months ago
.mocharc.yaml feat(build): es2015 bundle artifact (#6291) 1 year ago
.npmignore fix(build): add es-bundle to .npmignore non-exclusion list (#6328) 1 year ago
.npmrc chore(package): freeze release-it library and it's deps 1 year ago
.prettierrc.yaml feat: Multiple Examples for OpenAPI 3 Parameters, Request Bodies, and Responses (via #5427) 2 years ago
Dockerfile add swagger url option (#6122) 1 year ago
LICENSE Use official apache 2.0 license text (#5470) 1 year ago
README.md Improve documentation for Standalone plain HTML installation (#6605) 10 months ago
SECURITY.md housekeeping: create `.github/SECURITY.md` (via #5514) 2 years ago
babel.config.js feat(build): use core-js@3 (#6410) 1 year ago
composer.json Update composer.json 4 years ago
cypress.json housekeeping: automated releases via `release-it` (via #4875) 3 years ago
package-lock.json chore(release): cut the v3.37.2 release 10 months ago
package.json chore(release): cut the v3.37.2 release 10 months ago
renovate.json chore(package): freeze release-it library and it's deps 1 year ago
snapcraft.yaml Add the daemon 4 years ago
swagger-config.yaml improvement: `online.swagger.io` -> `validator.swagger.io` (#5599) 2 years ago

README.md

NPM version Build Status npm audit total GitHub contributors

monthly npm installs total docker pulls monthly packagist installs gzip size

👉🏼 Want to score an easy open-source contribution? Check out our Good first issue label.

🕰️ Looking for the older version of Swagger UI? Refer to the 2.x branch.

This repository publishes three different NPM modules:

  • 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.

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.

Compatibility

The OpenAPI Specification has undergone 5 revisions since initial creation in 2010. Compatibility between Swagger UI and the OpenAPI Specification is as follows:

Swagger UI Version Release Date OpenAPI Spec compatibility Notes
3.18.3 2018-08-03 2.0, 3.0 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

Documentation

Usage

Customization

Development

Contributing

Integration Tests

You will need JDK of version 7 or higher as instructed here https://nightwatchjs.org/gettingstarted/#selenium-server-setup

Integration tests can be run locally with npm run e2e - be sure you aren’t running a dev server when testing!

Browser support

Swagger UI works in the latest versions of Chrome, Safari, Firefox, and Edge.

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.

  • 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.