Skip to content
This repository has been archived by the owner on Feb 28, 2019. It is now read-only.

Commit

Permalink
Add doc entry about swagger-ui
Browse files Browse the repository at this point in the history
  • Loading branch information
archiloque committed Apr 11, 2015
1 parent 87b17f3 commit 90ccfda
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,14 @@ The swagger json endpoint will be exposed at `/swagger_doc.json`.
A more complete example is available [here](https://github.com/archiloque/sinatra-swagger-exposer/tree/master/example).
## About swagger-ui
- If you to use [swagger-ui](https://github.com/swagger-api/swagger-ui) with your app you will need to add croo-origin setup.
The easiest way is to use the [sinatra-cross_origin](https://github.com/britg/sinatra-cross_origin) gem. Fro a simple sample you can have a look at [example application](https://github.com/archiloque/sinatra-swagger-exposer/tree/master/example).
- Swagger-ui doesn't work with all the swagger features
- Some of them like parameters maximum and minimum values are ignored
- Some of them like extending types make the endpoint unusable

## Changes

Changelog is [here](https://github.com/archiloque/sinatra-swagger-exposer/blob/master/CHANGELOG.md).
Expand Down

0 comments on commit 90ccfda

Please sign in to comment.