typeable/servant-swagger-ui
1
0
Fork 0
mirror of https://github.com/typeable/servant-swagger-ui.git synced 2024-11-04 05:56:33 +03:00
Code Issues Projects Releases Wiki Activity
Provide embedded swagger UI for servant and swagger
96 Commits 5 Branches 19 Tags 10 MiB
Haskell 88.2%
HTML 11.8%
4071f86ad5
Go to file
Oleg Grenrus 4071f86ad5
Merge pull request #49 from phadej/aeson-1.4 
Allow aeson-1.4
2018-06-12 16:34:36 +03:00
servant-swagger-ui Allow aeson-1.4 2018-06-12 14:16:54 +03:00
servant-swagger-ui-core Allow aeson-1.4 2018-06-12 14:16:54 +03:00
servant-swagger-ui-example Allow aeson-1.4 2018-06-12 14:16:54 +03:00
servant-swagger-ui-jensoleg Allow aeson-1.4 2018-06-12 14:16:54 +03:00
servant-swagger-ui-redoc Allow aeson-1.4 2018-06-12 14:16:54 +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 Allow aeson-1.4 2018-06-12 14:16:54 +03:00
cabal.make-travis-yml Support GHC-8.4.1 2018-03-23 08:16:39 +02: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

README.md

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>. 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