WebGear.Middlewares.Body

Middlewares related to HTTP body.

Documentation

data JSONRequestBody (t :: Type)

A Trait for converting a JSON request body into a value.

Instances

(FromJSON t, MonadIO m) => Trait (JSONRequestBody t :: Type) Request m

Defined in WebGear.Middlewares.Body

Associated Types

type Attribute (JSONRequestBody t) Request

type Absence (JSONRequestBody t) Request

Methods

toAttribute :: Request -> m (Result (JSONRequestBody t) Request)

type Attribute (JSONRequestBody t :: Type) Request

Defined in WebGear.Middlewares.Body

type Attribute (JSONRequestBody t :: Type) Request = t

type Absence (JSONRequestBody t :: Type) Request

Defined in WebGear.Middlewares.Body

type Absence (JSONRequestBody t :: Type) Request = Text

jsonRequestBody :: forall t m req a. (FromJSON t, MonadRouter m, MonadIO m) => RequestMiddleware' m req (JSONRequestBody t ': req) a

A middleware to parse the request body as JSON and convert it to a value via a FromJSON instance.

Usage for a type t which has a FromJSON instance:

jsonRequestBody @t handler

Returns a 400 Bad Request response on failure to parse body.

jsonResponseBody :: (ToJSON t, Monad m) => ResponseMiddleware' m req t ByteString

A middleware that converts the response that has a ToJSON instance to a ByteString response.

This will also set the "Content-Type" header of the response to "application/json".

Usage for a type t which has a ToJSON instance:

jsonResponseBody @t handler