bubblev
/
swagger-ui
4
0
Fork 0
Koodi Ongelmat 0 Pull-pyynnöt 0 Julkaisut 0 Wiki Toiminta
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.
4059 Commitit
2 Branchit
306 MiB
 
 
 
 
Puu: daf680c695
Branchit Tagit
${ item.name }
Create branch ${ searchTerm }
from 'daf680c695'
${ noResults }
 ZIP  TAR.GZ
kyle daf680c695
housekeeping: silence lock bot for initial wave of actions (#5439) 		5 vuotta sitten
.github housekeeping: silence lock bot for initial wave of actions (#5439) 5 vuotta sitten
dev-helpers improvement: prevent loading resources from third party CDN (via #4598) 6 vuotta sitten
dist release: v3.23.0 5 vuotta sitten
docker feature: add `withCredentials` configuration key (via #5149) 5 vuotta sitten
docs feature: add `withCredentials` configuration key (via #5149) 5 vuotta sitten
flavors/swagger-ui-react housekeeping: allow overriding `swagger-ui-react` version` (via #5300) 5 vuotta sitten
release housekeeping: force release-it to base version bumps on package manifest (via #5301) 5 vuotta sitten
src feat: Multiple Examples for OpenAPI 3 Parameters, Request Bodies, and Responses (via #5427) 5 vuotta sitten
swagger-ui-dist-package Maintain backwards compatibility with absolutePath 7 vuotta sitten
test feat: Multiple Examples for OpenAPI 3 Parameters, Request Bodies, and Responses (via #5427) 5 vuotta sitten
.agignore add .aignore 7 vuotta sitten
.babelrc housekeeping: bundle size reductions (#4713) 6 vuotta sitten
.dockerignore feature: full-spectrum runtime Docker configuration (via #4965) 5 vuotta sitten
.editorconfig Create .editorconfig 7 vuotta sitten
.eslintrc housekeeping: `.js` -> `.jsx` file extensions (via #5014) 5 vuotta sitten
.gitattributes Set EOL of docker-run.sh to LF 7 vuotta sitten
.gitignore feature: `swagger-ui-react` module (via #5207) 5 vuotta sitten
.npmignore improve(npm-module): include standalone preset in `swagger-ui` (#4101) 6 vuotta sitten
.prettierrc.yaml feat: Multiple Examples for OpenAPI 3 Parameters, Request Bodies, and Responses (via #5427) 5 vuotta sitten
CONTRIBUTING.md docs(contributing): add merging pull requests section (#4076) 6 vuotta sitten
Dockerfile fix: generate gzipped Docker assets at runtime (via #5219) 5 vuotta sitten
LICENSE housekeeping: happy new year! (via #5102) 5 vuotta sitten
README.md Update README.md 5 vuotta sitten
composer.json Update composer.json 7 vuotta sitten
cypress.json housekeeping: automated releases via `release-it` (via #4875) 6 vuotta sitten
make-webpack-config.js feat: Multiple Examples for OpenAPI 3 Parameters, Request Bodies, and Responses (via #5427) 5 vuotta sitten
package-lock.json feat: Multiple Examples for OpenAPI 3 Parameters, Request Bodies, and Responses (via #5427) 5 vuotta sitten
package.json release: v3.23.0 5 vuotta sitten
postcss.config.js Fixes #3334 - Add autoprefixer back to postcss plugins 7 vuotta sitten
snapcraft.yaml Add the daemon 7 vuotta sitten
swagger-config.yaml improvement: generate default oauth2RedirectUrl based on page location (via #5085) 5 vuotta sitten
webpack-dist-bundle.config.js build(umd-module): prevent mangling (#4320) 6 vuotta sitten
webpack-dist-standalone.config.js build(umd-module): prevent mangling (#4320) 6 vuotta sitten
webpack-dist.config.js Revert "initial perf, which gets stripped out in production (#4131)" (#4636) 6 vuotta sitten
webpack-hot-dev-server.config.js feat: Multiple Examples for OpenAPI 3 Parameters, Request Bodies, and Responses (via #5427) 5 vuotta sitten
webpack-watch.config.js Revert "initial perf, which gets stripped out in production (#4131)" (#4636) 6 vuotta sitten
webpack.check.js Fixes #3329 - Tweak webpack config to share CSS loaders for production builders. Updated production builds to use `ExtractTextPlugin` so styles are not built into JS. 7 vuotta sitten
webpack.config.js Fixes #3329 - Tweak webpack config to share CSS loaders for production builders. Updated production builds to use `ExtractTextPlugin` so styles are not built into JS. 7 vuotta sitten
webpack.dist-style.config.js Moved split-pane-mode.less file into a .scss file. Removed remaining unused .less files. Removed reference to less file in webpack config. Removed dependency on less-loader. Updated standalone and bundle builds to no longer compile any styles. 7 vuotta sitten

README.md

NPM version Build Status

👉🏼 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 http://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, Edge and IE11.

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.

License

Copyright 2019 SmartBear Software

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.