WebGear.OpenApi.Handler

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

Documentation

newtype OpenApiHandler m a b

A handler that captures OpenApi documentation of API specifications.

Constructors

OpenApiHandler (OpenApi -> State Documentation OpenApi)

Instances

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

Defined in WebGear.OpenApi.Handler

Methods

raise :: OpenApiHandler m RouteMismatch b

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

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

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

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

Defined in WebGear.OpenApi.Handler

Methods

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

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

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

Defined in WebGear.OpenApi.Handler

Methods

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

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

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

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

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

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

Defined in WebGear.OpenApi.Handler

Methods

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

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

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

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

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

Defined in WebGear.OpenApi.Handler

Methods

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

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

Defined in WebGear.OpenApi.Handler

Methods

zeroArrow :: OpenApiHandler m b c

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

Defined in WebGear.OpenApi.Handler

Methods

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

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

setDescription :: Description -> OpenApiHandler m a a

setSummary :: Summary -> OpenApiHandler m a a

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

Defined in WebGear.OpenApi.Trait.Method

Methods

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

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

Defined in WebGear.OpenApi.Trait.Path

Methods

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

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

Defined in WebGear.OpenApi.Trait.Path

Methods

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

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

Defined in WebGear.OpenApi.Trait.Body

Methods

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

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

Defined in WebGear.OpenApi.Trait.Status

Methods

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

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

Defined in WebGear.OpenApi.Trait.Body

Methods

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

(KnownSymbol tag, ToSchema val) => Get (OpenApiHandler m :: Type -> Type -> Type) (PathVar tag val)

Defined in WebGear.OpenApi.Trait.Path

Methods

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

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

Defined in WebGear.OpenApi.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)) -> OpenApiHandler m (With Response ts, Attribute (Body mt val) Response) (With Response (Body mt val ': ts))

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

Defined in WebGear.OpenApi.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)) -> OpenApiHandler m (With Response ts, Attribute (SetCookie e name) Response) (With Response (SetCookie e name ': ts))

KnownSymbol name => Get (OpenApiHandler m :: Type -> Type -> Type) (Cookie e name val)

Defined in WebGear.OpenApi.Trait.Cookie

Methods

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

(KnownSymbol name, ToSchema val) => Set (OpenApiHandler m :: Type -> Type -> Type) (ResponseHeader 'Optional name val)

Defined in WebGear.OpenApi.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)) -> OpenApiHandler m (With Response ts, Attribute (ResponseHeader 'Optional name val) Response) (With Response (ResponseHeader 'Optional name val ': ts))

(KnownSymbol name, ToSchema val) => Set (OpenApiHandler m :: Type -> Type -> Type) (ResponseHeader 'Required name val)

Defined in WebGear.OpenApi.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)) -> OpenApiHandler m (With Response ts, Attribute (ResponseHeader 'Required name val) Response) (With Response (ResponseHeader 'Required name val ': ts))

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

Defined in WebGear.OpenApi.Trait.Header

Methods

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

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

Defined in WebGear.OpenApi.Trait.Header

Methods

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

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

Defined in WebGear.OpenApi.Trait.QueryParam

Methods

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

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

Defined in WebGear.OpenApi.Trait.QueryParam

Methods

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

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

Defined in WebGear.OpenApi.Trait.Auth.Basic

Methods

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

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

Defined in WebGear.OpenApi.Trait.Auth.JWT

Methods

getTrait :: forall (ts :: [Type]). Prerequisite (JWTAuth' x scheme m e a) ts => JWTAuth' x scheme m e a -> OpenApiHandler 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 => OpenApi -> m OpenApi

addRootPath :: OpenApi -> OpenApi

toOpenApi :: OpenApiHandler m a b -> OpenApi

Generate OpenApi documentation from a handler