typeable/servant-swagger-ui
1
0
Fork 0
mirror of https://github.com/typeable/servant-swagger-ui.git synced 2024-11-09 20:46:03 +03:00
Code Issues Projects Releases Wiki Activity
72674601cd
servant-swagger-ui/README.md
Hamish Mackenzie 67463553ea
Update links
2018-12-12 11:44:15 +13:00

1.5 KiB
Raw Blame History

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."

Build Status Hackage Stackage LTS 5 Stackage Nightly

Example

example screenshot

Check servant-swagger-ui-example/src/Main.hs for an example.

Development

Updating of bundled swagger-ui version:

  • Extract dist directory of swagger-ui into swagger-dist-<version>. Remove the *.map files.
  • update extra-source-files in the .cabal
  • move index.html into index.html.tmpl, do the diff, port the changes
  • search replace the embbeded directory (in Servant/Swagger/UI.hs)
  • test it works