b78ec5bd9d
* Add package-lock
* Remove karma* as no longer used. mocha is the test runner now
* Update patch and minor dev dependencies
* Update other dev dependencies, one at time
* Update webpack to v3 and fix package warnings
* Update production dependencies
* Update to react-inspector and Remove react-addons-shallow-compare as no longer used/required in 15.6
* Unused dependencies
* brace
* getbase
* matcher
* promise-worker
* react-addons-test-utils
* react-height
* redux-logger
* scroll-to-element
* shallowequal
* whatwg-fetch
* initial perf, which gets stripped out in production (#4131)
* Refactor deep-linking, in the process extracted out OperationsTag (#4349)
* add configsActions.loaded hook
* add OperationTag to hold Operations
* fix test for operations
* refactor deep-linking plugin
* [FIX] nested `url` option replacement when $API_URLS contains `url: .*,` pattern (#4601)
* fix(try-it-out): initially unset required booleans (#4613)
* fix(tio-params): disable empty values for required+enum booleans (#4615)
* feat(rendering): gate rendering based on valid version identifiers (#4614)
* create VersionPragmaFilter component
* use VersionPragmaFilter in BaseLayout
* tighten version idenitifier constraints
* handle case where user specifies a valid `swagger` and `openapi` field
* add traceable class names for each message
* add tests
* linter fixes!
* UNRELATED CHANGE: remove travis short-circuit
* add bypass switch to VersionPragmaFilter
* v3.17.0 (#4616)
* v3.17.0
* rebuild dist
* Update system.js (#4626)
Fix typo
* Revert "initial perf, which gets stripped out in production (#4131)" (#4636)
This reverts commit 5ea2150ae7.
* Update add-plugin.md (#4620)
Fixed some spacing
* fix: sample generation for nested oject schemas (#4648)
* Fix improper markdown (#4645)
escape `|`
* housekeeping: factor out components for easier BaseLayout reuse (#4604)
* improve: wrap schemes to encapsulate rendering logic
* improve: wrap filter to encapsulate rendering logic
* improve: wrap info section to encapsulate rendering logic
* improve: wrap servers plugin to encapsulate rendering logic
* improve: added tests for schemes-wrapper rendering logic
* improve: added tests for info-wrapper rendering logic, also do not render info if info is undefined
* improve: added tests for filter rendering logic
* improve: added tests for servers-wrapper rendering logic
* `InfoWrapper` -> `InfoContainer`
* add `containers` alias to Babel configuration
* `SchemesWrapper` -> `SchemesContainer`
* drop `container` from container file names
* `ServersWrapper` -> `ServersContainer`
* `Filter` -> `FilterContainer`
* follow `core/containers` pattern in BasePreset
* use HTTPS for Petstore by default (#4652)
* housekeeping: update e2e selectors (#4655)
* v3.17.1 (#4656)
* v3.17.1
* rebuild dist
* Doc updates
* Improvement: Hash-keyed Try-It-Out parameter value storage (#4670)
* allow param update by identity + hashed value storage
* add specActions.changeParamByIdentity
* add identity-based lookup support in spec selectors
* migrate `changeParam` usage to `changeParamByIdentity`
* migrate usage of `parameterWithMeta` to `parameterWithMetaByIdentity`
* update invocations of `changeParamByIdentity` to match fn signature
* use OrderedMap throughout hash-based selectors for consistency
* normalize usage of ParameterRow `onChange`
* migrate bug 4557 tests to reflect new ParameterRow interface
* remove exclusive test blocks
* linter fixes
* copy Parameters changes into OAS3 wrapper
* use rawParam for meta lookups in ParameterRow
* drop unused dependencies from `package.json`
* re-pin selenium dependency version
Swagger UI
👉🏼 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 two 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.
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.17.1 | 2018-06-16 | 2.0, 3.0 | tag v3.17.1 |
| 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
collectionFormatis 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 2018 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.