servant-swagger-0.1: Generate Swagger specification for your servant API.

Safe HaskellNone
LanguageHaskell2010

Servant.Swagger

Synopsis

Documentation

class HasSwagger api where Source

Methods

toSwagger :: Proxy api -> Swagger Source

Instances

HasSwagger * Raw Source 
(HasSwagger * a, HasSwagger * b) => HasSwagger * ((:<|>) a b) Source 
AllAccept [*] cs => HasSwagger * (Get cs ()) Source 
(ToSchema a, AllAccept [*] cs, AllToResponseHeader [*] hs) => HasSwagger * (Get cs (Headers hs a)) Source 
(ToSchema a, AllAccept [*] cs) => HasSwagger * (Get cs a) Source 
AllAccept [*] cs => HasSwagger * (Post cs ()) Source 
(ToSchema a, AllAccept [*] cs, AllToResponseHeader [*] hs) => HasSwagger * (Post cs (Headers hs a)) Source 
(ToSchema a, AllAccept [*] cs) => HasSwagger * (Post cs a) Source 
AllAccept [*] cs => HasSwagger * (Delete cs ()) Source 
(ToSchema a, AllAccept [*] cs, AllToResponseHeader [*] hs) => HasSwagger * (Delete cs (Headers hs a)) Source 
(ToSchema a, AllAccept [*] cs) => HasSwagger * (Delete cs a) Source 
AllAccept [*] cs => HasSwagger * (Put cs ()) Source 
(ToSchema a, AllAccept [*] cs, AllToResponseHeader [*] hs) => HasSwagger * (Put cs (Headers hs a)) Source 
(ToSchema a, AllAccept [*] cs) => HasSwagger * (Put cs a) Source 
AllAccept [*] cs => HasSwagger * (Patch cs ()) Source 
(ToSchema a, AllAccept [*] cs, AllToResponseHeader [*] hs) => HasSwagger * (Patch cs (Headers hs a)) Source 
(ToSchema a, AllAccept [*] cs) => HasSwagger * (Patch cs a) Source 
(ToSchema a, AllAccept [*] cs, HasSwagger k sub) => HasSwagger * ((:>) * k (ReqBody * cs a) sub) Source 
(KnownSymbol sym, ToParamSchema a, HasSwagger k sub) => HasSwagger * ((:>) * k (Header sym a) sub) Source 
(KnownSymbol sym, HasSwagger k sub) => HasSwagger * ((:>) * k (QueryFlag sym) sub) Source 
(KnownSymbol sym, ToParamSchema a, HasSwagger k sub) => HasSwagger * ((:>) * k (QueryParams * sym a) sub) Source 
(KnownSymbol sym, ToParamSchema a, HasSwagger k sub) => HasSwagger * ((:>) * k (QueryParam * sym a) sub) Source 
(KnownSymbol sym, ToParamSchema a, HasSwagger k sub) => HasSwagger * ((:>) * k (Capture * sym a) sub) Source 
(KnownSymbol sym, HasSwagger k sub) => HasSwagger * ((:>) Symbol k sym sub) Source 

addTag :: TagName -> Operation -> Operation Source

Tag an operation.

subOperations :: forall sub api. (IsSubAPI sub api, HasSwagger sub) => Proxy sub -> Proxy api -> Traversal' Swagger Operation Source

All operations of sub API.

setResponse :: HttpStatusCode -> Response -> Operation -> Operation Source

Set a response for an operation.

class ToResponseHeader h where Source

Methods

toResponseHeader :: Proxy h -> (HeaderName, Header) Source

Instances

class AllAccept cs Source

Minimal complete definition

allContentType

Instances

AllAccept [k] ([] k) Source 
(Accept k c, AllAccept [k] cs) => AllAccept [k] ((:) k c cs) Source 

class AllToResponseHeader hs Source

Minimal complete definition

toAllResponseHeaders

Instances