sorki / servant-swagger-ui

Provide embedded swagger UI for servant and swagger

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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

About

Provide embedded swagger UI for servant and swagger


Languages

Language:JavaScript 76.9%Language:CSS 21.7%Language:Haskell 0.9%Language:HTML 0.5%