kyy/swagger-ui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

removed unnecessary node_modules, updated some of the logic from pull request for docExpansion, onComplete and onFailure param support

Browse Source
This commit is contained in:
Ayush Gupta
2012-11-05 11:17:25 +05:30
parent b05f6f9cb5
commit 4a77d5a20f
55 changed files with 21 additions and 4227 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@@ -28,7 +28,7 @@ Once you open the Swagger UI, it will load the [Swagger Petstore](http://petstor
You can enter your own server url and click explore to view the API.
### Customize
You may choose to customize Swagger UI for your organization. Here is an overview of what the various directories contain
You may choose to customize Swagger UI for your organization. Here is an overview of whats in its various directories:
- dist: Contains a distribution which you can deploy on a server or load from your local machine.
- bin: Contains files used by swagger-ui for its build/test. These are not required by the distribution.
@@ -56,6 +56,9 @@ To use swagger-ui you should take a look at the [source of swagger-ui html page]
```
* *discoveryUrl* parameter should point to a resource listing url as per [Swagger Spec](https://github.com/wordnik/swagger-core/wiki)
* *dom_id parameter* is the the id of a dom element inside which SwaggerUi will put the user interface for swagger
* *docExpansion* controls how the API listing is displayed. It can be set to 'none' (default), 'list' (shows operations for each resource), or 'full' (fully expanded: shows operations and their details)
* *onComplete* is a callback function parameter which can be passed to be notified of when SwaggerUI has completed rendering successfully.
* *onFailure* is a callback function parameter which can be passed to be notified of when SwaggerUI encountered a failure was unable to render.
* All other parameters are explained in greater detail below