The servant-swagger-ui package

[ Tags: bsd3, library, servant, swagger, web ] [ Propose Tags ]

Provide embedded swagger UI for servant and swagger (i.e. servant-swagger)


[Skip to Readme]

Properties

Versions 0.1.0.2.1.4, 0.1.1.2.1.4, 0.2.0.2.1.5, 0.2.1.2.2.8, 0.2.2.2.2.8, 0.2.3.2.2.8, 0.2.4.3.0.20, 0.2.4.3.4.0
Change log CHANGELOG.md
Dependencies base (>=4.7 && <4.11), blaze-markup (>=0.7.0.2 && <0.9), bytestring (>=0.10.4.0 && <0.11), directory (>=1.2.1.0 && <1.4), either, file-embed (>=0.0.9 && <0.1), filepath (>=1.3.0.2 && <1.5), http-media (>=0.6.2 && <0.8), servant (>=0.4.4.5 && <0.13), servant-blaze (>=0.4.4.5 && <0.9), servant-server (>=0.4.4.5 && <0.13), servant-swagger (>=1.0.3 && <1.2), swagger2 (>=2.0.1 && <2.3), template-haskell (>=2.9 && <2.13), text (>=1.2.0.6 && <1.3), transformers (>=0.3 && <0.6), transformers-compat (>=0.3 && <0.6), wai-app-static (>=3.0.1.1 && <3.2) [details]
License BSD3
Author Oleg Grenrus <oleg.grenrus@iki.fi>
Maintainer Oleg Grenrus <oleg.grenrus@iki.fi>
Category Web, Servant, Swagger
Home page https://github.com/phadej/servant-swagger-ui#readme
Bug tracker https://github.com/phadej/servant-swagger-ui/issues
Source repository head: git clone https://github.com/phadej/servant-swagger-ui
Uploaded Wed Oct 25 11:41:58 UTC 2017 by phadej
Updated Wed Nov 8 09:56:37 UTC 2017 by phadej to revision 1
Distributions LTSHaskell:0.2.4.3.4.0, NixOS:0.2.4.3.4.0, Stackage:0.2.4.3.4.0, Tumbleweed:0.2.4.3.0.20
Downloads 4193 total (83 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2017-10-25 [all 1 reports]
Hackage Matrix CI

Modules

[Index]

Flags

NameDescriptionDefaultType
servant-0-5

Whether use servant >= 0.5

EnabledAutomatic

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

Maintainer's Corner

For package maintainers and hackage trustees


Readme for servant-swagger-ui-0.2.4.3.4.0

[back to package description]

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 example/Main.hs for an example.

Development

Updating of bundled swagger-ui version:

  • Extract dist directory of swagger-ui into swagger-dist-&lt;version&gt;
  • 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