Provide embedded swagger UI for servant and swagger


Keywords
library, servant, swagger, web, Propose Tags, https://github.com/swagger-api/swagger-ui, , Index, Quick Jump, Servant.Swagger.UI, servant-swagger-ui-0.3.5.5.0.0.tar.gz, browse, Package description, Package maintainers, AlpMestanogullari, DavidJohnson, GaelDeest, NickolayKudasov, phadej, MatthiasFischmann, maksbotan, arianvp, janus, edit package information , 0.3.2.3.19.3, 0.3.3.3.22.2, 0.3.4.3.22.2, 0.3.4.3.23.11, 0.3.4.3.36.1, hacktoberfest, haskell
License
BSD-3-Clause
Install
cabal install servant-swagger-ui-0.3.2.3.19.3

Documentation

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