servant-swagger-ui

Servant swagger ui

https://github.com/phadej/servant-swagger-ui#readme

Version on this page:0.2.4.3.0.20
LTS Haskell 23.21:0.3.5.5.0.1
Stackage Nightly 2025-05-05:0.3.5.5.0.1
Latest on Hackage:0.3.5.5.0.1

See all snapshots servant-swagger-ui appears in

BSD-3-Clause licensed and maintained by Oleg Grenrus
This version can be pinned in stack with:servant-swagger-ui-0.2.4.3.0.20@sha256:b8b0b69b5ebba6c95feb837d57dc3a2c9206e837b9a41af84ece06aea3c78492,5122

Module documentation for 0.2.4.3.0.20

  • Servant
    • Servant.Swagger
      • Servant.Swagger.UI
        • Servant.Swagger.UI.Internal

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-<version>
  • 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

Changes

  • 0.2.3.2.2.8

    • Support servant-0.11

  • 0.2.2.2.2.8

    • Support servant-0.10

  • 0.2.1.2.2.8

    • Update to swagger-ui-2.2.8
    • Add support for jensoleg theme

  • 0.2.0.2.1.5

  • 0.1.1.2.1.4

    • Documentation and example improvements