mellon-web-0.8.0.5: A REST web service for Mellon controllers

Copyright(c) 2018 Quixoftic LLC
LicenseBSD3
MaintainerDrew Hess <dhess-src@quixofticg.com>
Stabilityexperimental
Portabilitynon-portable
Safe HaskellNone
LanguageHaskell2010

Mellon.Web.Server.SwaggerAPI

Contents

Description

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

Synopsis

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