mirror of
https://github.com/typeable/servant-swagger-ui.git
synced 2024-08-15 01:10:23 +03:00
Provide embedded swagger UI for servant and swagger
|
||
---|---|---|
servant-swagger-ui | ||
servant-swagger-ui-core | ||
servant-swagger-ui-example | ||
servant-swagger-ui-jensoleg | ||
servant-swagger-ui-redoc | ||
.gitignore | ||
.stylish-haskell.yaml | ||
.travis.yml | ||
cabal.haskell-ci | ||
cabal.project | ||
README.md | ||
screenshot.png |
servant-swagger-ui
Provide a Swagger UI for your Servant API
"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."
Example
Check servant-swagger-ui-example/src/Main.hs
for an example.
Development
Updating of bundled swagger-ui version:
- Extract
dist
directory ofswagger-ui
intoswagger-dist-<version>
. Remove the*.map
files. - update
extra-source-files
in the.cabal
- move
index.html
intoindex.html.tmpl
, do the diff, port the changes - search replace the embbeded directory (in
Servant/Swagger/UI.hs
) - test it works