typeable/servant-swagger-ui
1
0
Fork 0
mirror of https://github.com/typeable/servant-swagger-ui.git synced 2024-09-17 09:27:15 +03:00
Code Issues Projects Releases Wiki Activity
Provide embedded swagger UI for servant and swagger
132 Commits 5 Branches 19 Tags 10 MiB
Haskell 88.2%
HTML 11.8%
4d6f115174
Go to file
Oleg Grenrus 4d6f115174
Merge pull request #75 from haskell-servant/swagger2-2.5 
Swagger2 2.5
2020-01-09 12:41:28 +02:00
servant-swagger-ui Regenerate .travis.yml, bump x-revision 2020-01-09 00:11:47 +02:00
servant-swagger-ui-core Regenerate .travis.yml, bump x-revision 2020-01-09 00:11:47 +02:00
servant-swagger-ui-example Allow base-4.13, base-compat-0.11 ... 2019-09-16 09:10:58 +03:00
servant-swagger-ui-jensoleg Regenerate .travis.yml, bump x-revision 2020-01-09 00:11:47 +02:00
servant-swagger-ui-redoc Regenerate .travis.yml, bump x-revision 2020-01-09 00:11:47 +02: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 Regenerate .travis.yml, bump x-revision 2020-01-09 00:11:47 +02:00
cabal.haskell-ci Allow servant-0.16 2019-02-27 20:11:40 +02:00
cabal.project WIP: split servant-swagger-ui into many packages 2018-04-05 14:45:22 +03:00
README.md Update links 2018-12-12 11:44:15 +13: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 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