swagger-ui

Fork of https://github.com/swagger-api/swagger-ui

Renovate Bot 8e0a46b489 housekeeping(dev-deps): terser-webpack-plugin@1.4.5		4 年之前
.github	Fix: typo in a feature request template (#6151)	4 年之前
config	feat(build): es2015 bundle artifact (#6291)	4 年之前
dev-helpers	fix: specify charset utf-8 in html script declaration (#6278)	4 年之前
dist	chore(release): cut the v3.32.2 release	4 年之前
docker	fix(Docker) #6211: Bug where SWAGGER_JSON is used without mount (#6212)	4 年之前
docs	docs(scripts): update building and testing scripts (#6298)	4 年之前
flavors/swagger-ui-react	feat(swagger-ui-react): es module (#6303)	4 年之前
release	refactor(release-it): update command substitution syntax (#6314)	4 年之前
src	fix(Models): onLoad should check this.props.layoutSelectors method (#6307)	4 年之前
swagger-ui-dist-package	Maintain backwards compatibility with absolutePath	7 年之前
test	chore(deps): update react-syntax-highlighter from 12.2.1 to 13.5.0 (#6312)	4 年之前
webpack	fix(build): css stylesheets bundle config and deps (#6315)	4 年之前
.agignore	add .aignore	7 年之前
.dockerignore	feature: full-spectrum runtime Docker configuration (via #4965)	5 年之前
.editorconfig	Create .editorconfig	7 年之前
.eslintrc	feat(build): es2015 bundle artifact (#6291)	4 年之前
.gitattributes	Set EOL of docker-run.sh to LF	7 年之前
.gitignore	feat(build): es2015 bundle artifact (#6291)	4 年之前
.mocharc.yaml	feat(build): es2015 bundle artifact (#6291)	4 年之前
.npmignore	improve(npm-module): include standalone preset in `swagger-ui` (#4101)	6 年之前
.npmrc	chore(package): freeze release-it library and it's deps	4 年之前
.prettierrc.yaml	feat: Multiple Examples for OpenAPI 3 Parameters, Request Bodies, and Responses (via #5427)	5 年之前
Dockerfile	add swagger url option (#6122)	4 年之前
LICENSE	Use official apache 2.0 license text (#5470)	4 年之前
README.md	No more IE11	4 年之前
SECURITY.md	housekeeping: create `.github/SECURITY.md` (via #5514)	5 年之前
babel.config.js	feat(build): es2015 bundle artifact (#6291)	4 年之前
composer.json	Update composer.json	7 年之前
cypress.json	housekeeping: automated releases via `release-it` (via #4875)	6 年之前
package-lock.json	housekeeping(dev-deps): terser-webpack-plugin@1.4.5	4 年之前
package.json	housekeeping(dev-deps): mini-css-extract-plugin@^0.10.0	4 年之前
renovate.json	chore(package): freeze release-it library and it's deps	4 年之前
snapcraft.yaml	Add the daemon	7 年之前
swagger-config.yaml	improvement: `online.swagger.io` -> `validator.swagger.io` (#5599)	5 年之前

README.md

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

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

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.