Provide embedded swagger UI for servant and swagger
Go to file
Oleg Grenrus 71ee4b64c3 Support servant-0.14
Move to haskell-servant organisation
2018-06-19 14:33:36 +03:00
servant-swagger-ui Support servant-0.14 2018-06-19 14:33:36 +03:00
servant-swagger-ui-core Support servant-0.14 2018-06-19 14:33:36 +03:00
servant-swagger-ui-example Support servant-0.14 2018-06-19 14:33:36 +03:00
servant-swagger-ui-jensoleg Support servant-0.14 2018-06-19 14:33:36 +03:00
servant-swagger-ui-redoc Support servant-0.14 2018-06-19 14:33:36 +03:00
.gitignore Support GHC-8.2 2017-07-15 10:46:03 +03:00
.stylish-haskell.yaml Introduce SwaggerSchemaUI 2016-08-19 15:31:10 +03:00
.travis.yml Support servant-0.14 2018-06-19 14:33:36 +03:00
cabal.make-travis-yml Support servant-0.14 2018-06-19 14:33:36 +03:00
cabal.project WIP: split servant-swagger-ui into many packages 2018-04-05 14:45:22 +03:00
README.md Update to Swagger UI 3.9.1 (#40) 2018-02-08 15:59:00 +02:00
screenshot.png Support servant-0.13 2018-02-09 20:32:46 +02:00

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 APIs resources without having any of the implementation logic in place."

Build Status Hackage Stackage LTS 5 Stackage Nightly

Example

example screenshot

Check example/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