git.iko.soy/typeable/servant-swagger-ui
on servant-swagger-ui-redoc-0.3.0.1.21.2 help sign in
typeable/servant-swagger-ui/README.md
26 lines 1.4 kB history raw
1# servant-swagger-ui
3*Provide a Swagger UI for your Servant API*
5"[Swagger UI](http://swagger.io/swagger-ui/) allows anyone — be it your development team or your end consumers — to visualize and interact with the API’s resources without having any of the implementation logic in place."
7[![Build Status](https://travis-ci.org/phadej/servant-swagger-ui.svg?branch=master)](https://travis-ci.org/phadej/servant-swagger-ui)
8[![Hackage](https://img.shields.io/hackage/v/servant-swagger-ui.svg)](http://hackage.haskell.org/package/servant-swagger-ui)
9[![Stackage LTS 5](http://stackage.org/package/servant-swagger-ui/badge/lts-5)](http://stackage.org/lts-5/package/servant-swagger-ui)
10[![Stackage Nightly](http://stackage.org/package/servant-swagger-ui/badge/nightly)](http://stackage.org/nightly/package/servant-swagger-ui)
12## Example
14![example screenshot](https://raw.githubusercontent.com/phadej/servant-swagger-ui/master/screenshot.png)
16Check [`example/Main.hs`](https://github.com/phadej/servant-swagger-ui/blob/master/example/Main.hs) for an example.
18## Development
20### Updating of bundled swagger-ui version:
22- Extract `dist` directory of `swagger-ui` into `swagger-dist-<version>`. Remove the `*.map` files.
23- update `extra-source-files` in the `.cabal`
24- move `index.html` into `index.html.tmpl`, do the diff, port the changes
25- search replace the embbeded directory (in `Servant/Swagger/UI.hs`)
26- test it works