| Copyright | (c) 2018 Quixoftic LLC |
|---|---|
| License | BSD3 |
| Maintainer | Drew Hess <dhess-src@quixofticg.com> |
| Stability | experimental |
| Portability | non-portable |
| Safe Haskell | None |
| Language | Haskell2010 |
Mellon.Web.Server.SwaggerAPI
Description
- type SwaggerAPI = MellonAPI :<|> SwaggerSchemaUI "swagger-ui" "swagger.json"
- swaggerAPI :: Proxy SwaggerAPI
- swaggerApp :: Controller d -> Application
- swaggerServer :: Controller d -> Server SwaggerAPI
- mellonSwagger :: Swagger
- writeSwaggerJSON :: IO ()
Types
type SwaggerAPI = MellonAPI :<|> SwaggerSchemaUI "swagger-ui" "swagger.json" Source #
Extends MellonAPI with a Swagger resource.
Servant / WAI functions
swaggerAPI :: Proxy SwaggerAPI Source #
A Proxy for SwaggerAPI, exported in order to make it possible
to extend the API further.
swaggerApp :: Controller d -> Application Source #
A WAI Application which runs the service, using the
given Controller
swaggerServer :: Controller d -> Server SwaggerAPI Source #
A Server which serves the SwaggerAPI on the given
Controller.
Normally you will just use swaggerApp, but this function is
exported so that you can extend/wrap SwaggerAPI.
Swagger meta-data
Convenience functions
writeSwaggerJSON :: IO () Source #