Mellon.Web.Server.SwaggerAPI

This module extends the standard MellonAPI with a Swagger resource. In every other way, it is identical to the MellonAPI service.

Types

type SwaggerAPI = MellonAPI :<|> SwaggerSchemaUI "swagger-ui" "swagger.json"

Extends MellonAPI with a Swagger resource.

Servant / WAI functions

swaggerAPI :: Proxy SwaggerAPI

A Proxy for SwaggerAPI, exported in order to make it possible to extend the API further.

swaggerApp :: Controller d -> Application

A WAI Application which runs the service, using the given Controller

swaggerServer :: Controller d -> Server SwaggerAPI

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

mellonSwagger :: Swagger

Convenience functions

writeSwaggerJSON :: IO ()