Skip to content

Swagger UI is a dependency-free collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.

License

Notifications You must be signed in to change notification settings

phorest/swagger-ui

 
 

Repository files navigation

Swagger UI responsive theme

With inspiration from the Auth0 api explorer the original Swagger UI repo is modified to use a responsive layout.

Swagger Theme example

The theme will adapt to screen size and works on tablets and mobile phones.

Swagger Theme example

A JSON editor for the request body (disabled by default).

Swagger JSON editor example

JSON editor configuration example:

                jsonEditor: true,
                jsonEditorOptions: {
                    disableProperties:false,
                    disableEditJson:false,
                    removeEmptyProperties:true,
                    noDefaultProperties:true
                },
                docExpansion: "none",
                sorter: "alpha",

Run locally

npm install ./node_modules/gulp/bin/gulp.js serve

Deployment

To deploy the project please use the Jekins Deploy Job using the VPN

Disclaimer

This is not a fully polished implementation and should be used with care.

License

Copyright 2011-2015 Reverb technologies, Inc.

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.

About

Swagger UI is a dependency-free collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • CSS 56.8%
  • JavaScript 35.6%
  • Less 4.5%
  • Handlebars 1.9%
  • HTML 1.1%
  • Dockerfile 0.1%