https://github.com/jensoleg/swagger-ui

Swagger UI is a dependency-free collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.
https://github.com/jensoleg/swagger-ui

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/jensoleg/swagger-ui
• Owner: jensoleg
• License: other
• Fork: true (swagger-api/swagger-ui)
• Created: 2015-04-28T19:37:20.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2023-09-14T11:55:44.000Z (about 1 year ago)
• Last Synced: 2024-09-21T16:44:14.665Z (about 2 months ago)
• Language: JavaScript
• Homepage: http://swagger.io
• Size: 16.7 MB
• Stars: 1,133
• Watchers: 47
• Forks: 310
• Open Issues: 45
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Swagger UI responsive theme

With inspiration from the [Auth0 api explorer](https://auth0.com/docs/apiv2) the original Swagger UI repo is modified to use a responsive layout.

[![Swagger Theme example](dist/images/Swagger_explorer.png)](http://ecs.bobbytech.dk/api)

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

[![Swagger Theme example](dist/images/Swagger_explorer_min.png)](http://ecs.bobbytech.dk/api)

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

![Swagger JSON editor example](dist/images/json_editor_integration.png)

JSON editor configuration example:

```javascript

                jsonEditor: true,

                jsonEditorOptions: {

                    disableProperties:false,

                    disableEditJson:false,

                    removeEmptyProperties:true,

                    noDefaultProperties:true

                },

                docExpansion: "none",

                sorter: "alpha",

```

Give it a [try](http://swaggerui.herokuapp.com/?url=http://petstore.swagger.io/v2/swagger.json) and enter your own swagger definition.

## 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](http://www.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.