mirror of
https://github.com/typeable/servant-swagger-ui.git
synced 2024-09-17 09:27:15 +03:00
Provide embedded swagger UI for servant and swagger
|
|
||
|---|---|---|
| example | ||
| jensoleg-dist | ||
| src/Servant/Swagger | ||
| swagger-ui-dist-3.4.0 | ||
| .gitignore | ||
| .stylish-haskell.yaml | ||
| .travis.yml | ||
| CHANGELOG.md | ||
| hackage-docs.sh | ||
| index.html.tmpl | ||
| jensoleg.index.html.tmpl | ||
| LICENSE | ||
| README.md | ||
| screenshot.png | ||
| servant-swagger-ui.cabal | ||
| Setup.hs | ||
| stack-lts-2.yaml | ||
| stack-lts-5.yaml | ||
| stack.yaml | ||
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 example/Main.hs for an example.
Development
Updating of bundled swagger-ui version:
- Extract
distdirectory ofswagger-uiintoswagger-dist-<version> - move
index.htmlintoindex.html.tmpl, do the diff, port the changes - search replace the embbeded directory (in
Servant/Swagger/UI.hs) - test it works