Servant.API.Routes.Body

The Body type lets us represent HTTP bodies that may have interpretations as several different types.

Documentation

data Body

A more expressive sum-type than just a list. This can be useful in situations where a body (request or response) may have several interpretations.

For example, the UVerb combinator lets us represent an endpoint that may return one of several types: hence the _routeResponseType field needs to be able to contain several TypeReps as a disjunction.

On the other hand, if multiple ReqBody's are chained together with :>, the resulting type's HasServer instance would try to parse the request body as all of the relevant types. In this case the _routeRequestBody field needs to be able to contain several TypeReps as a conjunction.

Instances

Monoid Body

Defined in Servant.API.Routes.Internal.Body

Methods

mempty :: Body

mappend :: Body -> Body -> Body

mconcat :: [Body] -> Body

Semigroup Body

Defined in Servant.API.Routes.Internal.Body

Methods

(<>) :: Body -> Body -> Body

sconcat :: NonEmpty Body -> Body

stimes :: Integral b => b -> Body -> Body

Show Body

Defined in Servant.API.Routes.Internal.Body

Methods

showsPrec :: Int -> Body -> ShowS

show :: Body -> String

showList :: [Body] -> ShowS

Eq Body

Defined in Servant.API.Routes.Internal.Body

Methods

(==) :: Body -> Body -> Bool

(/=) :: Body -> Body -> Bool

noBody :: Body

There is no request/response body. Equialent to Nothing or Null.

oneType :: forall a. Typeable a => Body

The request/response body can only be of one type. Equivalent to a single ReqBody _ a.

manyTypes :: forall as. AllTypeable as => Body

The body admits multiple representations. For more expressive aliases, use allOf or oneOf.

allOf :: forall as. AllTypeable as => Body

The request body must satisfy several FromJSON instances. Equivalent to multiple ReqBody's chained with :>, or OpenApi's [allOf](https:/swagger.iodocsspecificationdata-modelsoneof-anyof-allof-not#allof).

Alias for manyTypes.

oneOf :: forall as. AllTypeable as => Body

The response body could be one of several types. Equivalent to the UVerb combinator, or OpenApi's oneOf.

Alias for manyTypes.