|Number of watchers on Github||10876|
|Number of open issues||214|
|Average time to close an issue||4 days|
|Average time to merge a PR||2 days|
|Open pull requests||155+|
|Closed pull requests||78+|
|Last commit||over 1 year ago|
|Repo Created||about 8 years ago|
|Repo Last Updated||over 1 year ago|
|Organization / Author||swagger-api|
|Do you use swagger-ui? Leave a review!|
|View open issues (214)|
|View swagger-ui activity|
|View on github|
|Fresh, new opensource launches 🚀🚀🚀|
Trendy new open source projects in your inbox! View examples
This is the new version of swagger-ui, 3.x. Want to learn more? Check out our FAQ.
** Want to score an easy open-source contribution?** Check out our Good first issue label.
As a brand new version, written from the ground up, there are some known issues and unimplemented features. Check out the Known Issues section for more details.
This repository publishes to two different NPM modules:
For the older version of swagger-ui, refer to the 2.x branch.
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.12.1||2018-03-09||2.0, 3.0||tag v3.12.1|
|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|
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!
Swagger UI works in the latest versions of Chrome, Safari, Firefox, Edge and IE11.
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.
Please disclose any security-related issues or vulnerabilities by emailing firstname.lastname@example.org, instead of using the public issue tracker.
Copyright 2017 SmartBear Software
Licensed under the Apache License, Version 2.0 (the
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.
Interface changes: none.
data:scheme (via #4236)
Interface changes: none.
x-examplefields and use them as initial values (via #3538)
deepLinkingoptions now play well together, by using
location.replaceStateto update the
urls.primaryNamesetting in the browser query string (via #4181)
filteris now housed within a plugin, which allows custom filtering logic through the plugin system (via #4255)
consumesvalue regression (#4265)
baseDocto Swagger-Client (via #4273)
email@example.com solve a fatal error experienced by a small subset of users (via #4270)
This release includes significant improvements to Swagger-UI's performance. The concept of an entirely-resolved spec representation has been done away with in favor of resolved subtrees: as the user expands operations and models in Swagger-UI, work is done to resolve only the parts needed for display. This allows us to do initial renders more quickly and paves the way for a more responsive editing experience in Swagger-Editor.
As a result, there are some breaking changes to various private APIs (mostly
spec facilities that focus on the resolved state). If you run custom plugins that rely on that data, you'll want to check for compatibility before upgrading.
As a reminder: breaking private API changes result in a minor version bump, not a major bump.
defaultModelsExpandDepthbehavior has changed; the default
1value now leaves all models collapsed for performance reasons related to the new lazy resolution.
specResolvedis no longer updated by default; plugins that rely on it should move to
lodashdependency due to potential vulnerability (via #4224)