WebGear.Swagger.Handler

An implementation of Handler to generate Swagger documentation from WebGear API specifications.

Documentation

newtype SwaggerHandler m a b

A handler that captures Swagger documentation of API specifications.

Constructors

SwaggerHandler (Swagger -> State Documentation Swagger)

Instances

ArrowError RouteMismatch (SwaggerHandler m :: Type -> Type -> Type)

Defined in WebGear.Swagger.Handler

Methods

raise :: SwaggerHandler m RouteMismatch b

handle :: SwaggerHandler m e b -> SwaggerHandler m (e, RouteMismatch) b -> SwaggerHandler m e b

tryInUnless :: SwaggerHandler m e b -> SwaggerHandler m (e, b) c -> SwaggerHandler m (e, RouteMismatch) c -> SwaggerHandler m e c

newError :: SwaggerHandler m e b -> SwaggerHandler m e (Either RouteMismatch b)

Category (SwaggerHandler m :: k2 -> k2 -> Type)

Defined in WebGear.Swagger.Handler

Methods

id :: forall (a :: k). SwaggerHandler m a a

(.) :: forall (b :: k) (c :: k) (a :: k). SwaggerHandler m b c -> SwaggerHandler m a b -> SwaggerHandler m a c

Arrow (SwaggerHandler m :: Type -> Type -> Type)

Defined in WebGear.Swagger.Handler

Methods

arr :: (b -> c) -> SwaggerHandler m b c

first :: SwaggerHandler m b c -> SwaggerHandler m (b, d) (c, d)

second :: SwaggerHandler m b c -> SwaggerHandler m (d, b) (d, c)

(***) :: SwaggerHandler m b c -> SwaggerHandler m b' c' -> SwaggerHandler m (b, b') (c, c')

(&&&) :: SwaggerHandler m b c -> SwaggerHandler m b c' -> SwaggerHandler m b (c, c')

ArrowChoice (SwaggerHandler m :: Type -> Type -> Type)

Defined in WebGear.Swagger.Handler

Methods

left :: SwaggerHandler m b c -> SwaggerHandler m (Either b d) (Either c d)

right :: SwaggerHandler m b c -> SwaggerHandler m (Either d b) (Either d c)

(+++) :: SwaggerHandler m b c -> SwaggerHandler m b' c' -> SwaggerHandler m (Either b b') (Either c c')

(|||) :: SwaggerHandler m b d -> SwaggerHandler m c d -> SwaggerHandler m (Either b c) d

ArrowPlus (SwaggerHandler m :: Type -> Type -> Type)

Defined in WebGear.Swagger.Handler

Methods

(<+>) :: SwaggerHandler m b c -> SwaggerHandler m b c -> SwaggerHandler m b c

ArrowZero (SwaggerHandler m :: Type -> Type -> Type)

Defined in WebGear.Swagger.Handler

Methods

zeroArrow :: SwaggerHandler m b c

Monad m => Handler (SwaggerHandler m :: Type -> Type -> Type) m

Defined in WebGear.Swagger.Handler

Methods

arrM :: (a -> m b) -> SwaggerHandler m a b

consumeRoute :: SwaggerHandler m RoutePath a -> SwaggerHandler m () a

setDescription :: Description -> SwaggerHandler m a a

setSummary :: Summary -> SwaggerHandler m a a

Get (SwaggerHandler m :: Type -> Type -> Type) Method

Defined in WebGear.Swagger.Trait.Method

Methods

getTrait :: forall (ts :: [Type]). Prerequisite Method ts => Method -> SwaggerHandler m (With Request ts) (Either (Absence Method) (Attribute Method Request))

Get (SwaggerHandler m :: Type -> Type -> Type) Path

Defined in WebGear.Swagger.Trait.Path

Methods

getTrait :: forall (ts :: [Type]). Prerequisite Path ts => Path -> SwaggerHandler m (With Request ts) (Either (Absence Path) (Attribute Path Request))

Get (SwaggerHandler m :: Type -> Type -> Type) PathEnd

Defined in WebGear.Swagger.Trait.Path

Methods

getTrait :: forall (ts :: [Type]). Prerequisite PathEnd ts => PathEnd -> SwaggerHandler m (With Request ts) (Either (Absence PathEnd) (Attribute PathEnd Request))

Set (SwaggerHandler m :: Type -> Type -> Type) UnknownContentBody

Defined in WebGear.Swagger.Trait.Body

Methods

setTrait :: forall (ts :: [Type]). UnknownContentBody -> (With Response ts -> Response -> Attribute UnknownContentBody Response -> With Response (UnknownContentBody ': ts)) -> SwaggerHandler m (With Response ts, Attribute UnknownContentBody Response) (With Response (UnknownContentBody ': ts))

Set (SwaggerHandler m :: Type -> Type -> Type) Status

Defined in WebGear.Swagger.Trait.Status

Methods

setTrait :: forall (ts :: [Type]). Status -> (With Response ts -> Response -> Attribute Status Response -> With Response (Status ': ts)) -> SwaggerHandler m (With Response ts, Attribute Status Response) (With Response (Status ': ts))

(ToSchema val, MIMEType mt) => Get (SwaggerHandler m :: Type -> Type -> Type) (Body mt val)

Defined in WebGear.Swagger.Trait.Body

Methods

getTrait :: forall (ts :: [Type]). Prerequisite (Body mt val) ts => Body mt val -> SwaggerHandler m (With Request ts) (Either (Absence (Body mt val)) (Attribute (Body mt val) Request))

KnownSymbol tag => Get (SwaggerHandler m :: Type -> Type -> Type) (PathVar tag val)

Defined in WebGear.Swagger.Trait.Path

Methods

getTrait :: forall (ts :: [Type]). Prerequisite (PathVar tag val) ts => PathVar tag val -> SwaggerHandler m (With Request ts) (Either (Absence (PathVar tag val)) (Attribute (PathVar tag val) Request))

(ToSchema val, MIMEType mt) => Set (SwaggerHandler m :: Type -> Type -> Type) (Body mt val)

Defined in WebGear.Swagger.Trait.Body

Methods

setTrait :: forall (ts :: [Type]). Body mt val -> (With Response ts -> Response -> Attribute (Body mt val) Response -> With Response (Body mt val ': ts)) -> SwaggerHandler m (With Response ts, Attribute (Body mt val) Response) (With Response (Body mt val ': ts))

Set (SwaggerHandler m :: Type -> Type -> Type) (SetCookie e name)

Defined in WebGear.Swagger.Trait.Cookie

Methods

setTrait :: forall (ts :: [Type]). SetCookie e name -> (With Response ts -> Response -> Attribute (SetCookie e name) Response -> With Response (SetCookie e name ': ts)) -> SwaggerHandler m (With Response ts, Attribute (SetCookie e name) Response) (With Response (SetCookie e name ': ts))

Get (SwaggerHandler m :: Type -> Type -> Type) (Cookie e name val)

Defined in WebGear.Swagger.Trait.Cookie

Methods

getTrait :: forall (ts :: [Type]). Prerequisite (Cookie e name val) ts => Cookie e name val -> SwaggerHandler m (With Request ts) (Either (Absence (Cookie e name val)) (Attribute (Cookie e name val) Request))

KnownSymbol name => Set (SwaggerHandler m :: Type -> Type -> Type) (ResponseHeader 'Optional name val)

Defined in WebGear.Swagger.Trait.Header

Methods

setTrait :: forall (ts :: [Type]). ResponseHeader 'Optional name val -> (With Response ts -> Response -> Attribute (ResponseHeader 'Optional name val) Response -> With Response (ResponseHeader 'Optional name val ': ts)) -> SwaggerHandler m (With Response ts, Attribute (ResponseHeader 'Optional name val) Response) (With Response (ResponseHeader 'Optional name val ': ts))

KnownSymbol name => Set (SwaggerHandler m :: Type -> Type -> Type) (ResponseHeader 'Required name val)

Defined in WebGear.Swagger.Trait.Header

Methods

setTrait :: forall (ts :: [Type]). ResponseHeader 'Required name val -> (With Response ts -> Response -> Attribute (ResponseHeader 'Required name val) Response -> With Response (ResponseHeader 'Required name val ': ts)) -> SwaggerHandler m (With Response ts, Attribute (ResponseHeader 'Required name val) Response) (With Response (ResponseHeader 'Required name val ': ts))

(KnownSymbol name, ToParamSchema val) => Get (SwaggerHandler m :: Type -> Type -> Type) (RequestHeader 'Optional ps name val)

Defined in WebGear.Swagger.Trait.Header

Methods

getTrait :: forall (ts :: [Type]). Prerequisite (RequestHeader 'Optional ps name val) ts => RequestHeader 'Optional ps name val -> SwaggerHandler m (With Request ts) (Either (Absence (RequestHeader 'Optional ps name val)) (Attribute (RequestHeader 'Optional ps name val) Request))

(KnownSymbol name, ToParamSchema val) => Get (SwaggerHandler m :: Type -> Type -> Type) (RequestHeader 'Required ps name val)

Defined in WebGear.Swagger.Trait.Header

Methods

getTrait :: forall (ts :: [Type]). Prerequisite (RequestHeader 'Required ps name val) ts => RequestHeader 'Required ps name val -> SwaggerHandler m (With Request ts) (Either (Absence (RequestHeader 'Required ps name val)) (Attribute (RequestHeader 'Required ps name val) Request))

KnownSymbol name => Get (SwaggerHandler m :: Type -> Type -> Type) (QueryParam 'Optional ps name val)

Defined in WebGear.Swagger.Trait.QueryParam

Methods

getTrait :: forall (ts :: [Type]). Prerequisite (QueryParam 'Optional ps name val) ts => QueryParam 'Optional ps name val -> SwaggerHandler m (With Request ts) (Either (Absence (QueryParam 'Optional ps name val)) (Attribute (QueryParam 'Optional ps name val) Request))

KnownSymbol name => Get (SwaggerHandler m :: Type -> Type -> Type) (QueryParam 'Required ps name val)

Defined in WebGear.Swagger.Trait.QueryParam

Methods

getTrait :: forall (ts :: [Type]). Prerequisite (QueryParam 'Required ps name val) ts => QueryParam 'Required ps name val -> SwaggerHandler m (With Request ts) (Either (Absence (QueryParam 'Required ps name val)) (Attribute (QueryParam 'Required ps name val) Request))

KnownSymbol scheme => Get (SwaggerHandler m :: Type -> Type -> Type) (BasicAuth' x scheme m e a)

Defined in WebGear.Swagger.Trait.Auth.Basic

Methods

getTrait :: forall (ts :: [Type]). Prerequisite (BasicAuth' x scheme m e a) ts => BasicAuth' x scheme m e a -> SwaggerHandler m (With Request ts) (Either (Absence (BasicAuth' x scheme m e a)) (Attribute (BasicAuth' x scheme m e a) Request))

KnownSymbol scheme => Get (SwaggerHandler m :: Type -> Type -> Type) (JWTAuth' x scheme m e a)

Defined in WebGear.Swagger.Trait.Auth.JWT

Methods

getTrait :: forall (ts :: [Type]). Prerequisite (JWTAuth' x scheme m e a) ts => JWTAuth' x scheme m e a -> SwaggerHandler m (With Request ts) (Either (Absence (JWTAuth' x scheme m e a)) (Attribute (JWTAuth' x scheme m e a) Request))

data Documentation

Constructors

Documentation !(Maybe Description) !(Maybe Summary)

consumeDescription :: MonadState Documentation m => m (Maybe Description)

consumeSummary :: MonadState Documentation m => m (Maybe Summary)

addRouteDocumentation :: MonadState Documentation m => Swagger -> m Swagger

addRootPath :: Swagger -> Swagger

toSwagger :: SwaggerHandler m a b -> Swagger

Generate Swagger documentation from a handler