typeable/servant-swagger-ui
1
0
Fork 0
mirror of https://github.com/typeable/servant-swagger-ui.git synced 2024-07-07 02:56:23 +03:00
Code Issues Projects Releases Wiki Activity
Provide embedded swagger UI for servant and swagger
138 Commits 5 Branches 19 Tags 10 MiB
Haskell 88.2%
HTML 11.8%
master
Go to file
Maxim Koltsov 89a2415f50
Merge pull request #81 from haskell-servant/maksbotan/bump-versions 
Bump swagger-ui, bump versions

Fixes #80
Fixes #78
Fixes #79
2020-11-05 15:35:24 +03:00
servant-swagger-ui Drop GHC 7 2020-11-05 13:41:31 +03:00
servant-swagger-ui-core Drop GHC 7 2020-11-05 13:41:31 +03:00
servant-swagger-ui-example Drop GHC 7 2020-11-05 13:41:31 +03:00
servant-swagger-ui-jensoleg Drop GHC 7 2020-11-05 13:41:31 +03:00
servant-swagger-ui-redoc Drop GHC 7 2020-11-05 13:41:31 +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 Drop GHC 7 2020-11-05 13:41:31 +03:00
cabal.haskell-ci Support servant-0.17 2020-01-23 22:54:04 +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