bubblev
/
swagger-ui
4
0
Fork 0
Code Issues 0 Pull-Requests 0 Releases 0 Wiki Aktivität
Du kannst nicht mehr als 25 Themen auswählen Themen müssen entweder mit einem Buchstaben oder einer Ziffer beginnen. Sie können Bindestriche („-“) enthalten und bis zu 35 Zeichen lang sein.
4344 Commits
2 Branches
306 MiB
 
 
 
 
Struktur: e85b6f2837
Branches Tags
${ item.name }
Erstelle Branch ${ searchTerm }
von „e85b6f2837“
${ noResults }
 ZIP  TAR.GZ
Wesley Schwengle e85b6f2837
fix(Docker) #6211: Bug where SWAGGER_JSON is used without mount (#6212) 		vor 4 Jahren
.github Fix: typo in a feature request template (#6151) vor 4 Jahren
dev-helpers improvement: oauth "scopes" improvements (#6037) vor 4 Jahren
dist chore(release): cut the v3.28.0 release vor 4 Jahren
docker fix(Docker) #6211: Bug where SWAGGER_JSON is used without mount (#6212) vor 4 Jahren
docs fix: prevent CI trigger from docs/samples/webpack-getting-started (#6145) vor 4 Jahren
flavors/swagger-ui-react feat(swagger-ui-react): add `displayOperationId` config support (#5795) vor 4 Jahren
release build(release-it): configure proper release commit msg vor 4 Jahren
src feat(RequestBody): validation support for required fields (#6223) vor 4 Jahren
swagger-ui-dist-package Maintain backwards compatibility with absolutePath vor 7 Jahren
test feat(RequestBody): validation support for required fields (#6223) vor 4 Jahren
webpack build(webpack): move resolve alises to one common place vor 4 Jahren
.agignore add .aignore vor 7 Jahren
.babelrc bug: enum Select crashes when selecting the empty value (via #5463) vor 5 Jahren
.dockerignore feature: full-spectrum runtime Docker configuration (via #4965) vor 5 Jahren
.editorconfig Create .editorconfig vor 7 Jahren
.eslintrc housekeeping: `.js` -> `.jsx` file extensions (via #5014) vor 5 Jahren
.gitattributes Set EOL of docker-run.sh to LF vor 7 Jahren
.gitignore chore(git): add chromedriver.log to ignores vor 4 Jahren
.npmignore improve(npm-module): include standalone preset in `swagger-ui` (#4101) vor 6 Jahren
.npmrc chore(package): freeze release-it library and it's deps vor 4 Jahren
.prettierrc.yaml feat: Multiple Examples for OpenAPI 3 Parameters, Request Bodies, and Responses (via #5427) vor 5 Jahren
Dockerfile add swagger url option (#6122) vor 4 Jahren
LICENSE Use official apache 2.0 license text (#5470) vor 4 Jahren
README.md No more IE11 vor 4 Jahren
SECURITY.md housekeeping: create `.github/SECURITY.md` (via #5514) vor 5 Jahren
composer.json Update composer.json vor 7 Jahren
cypress.json housekeeping: automated releases via `release-it` (via #4875) vor 6 Jahren
package-lock.json build(bundle): use ES6 to import swagger-client symbols (#6208) vor 4 Jahren
package.json build(bundle): use ES6 to import swagger-client symbols (#6208) vor 4 Jahren
renovate.json chore(package): freeze release-it library and it's deps vor 4 Jahren
snapcraft.yaml Add the daemon vor 7 Jahren
swagger-config.yaml improvement: `online.swagger.io` -> `validator.swagger.io` (#5599) vor 5 Jahren

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