Servant.Benchmark.Endpoint

Documentation

data Endpoint

An API endpoint. -

Constructors

MkEndpoint

Fields

• name :: Text
• path :: Text
• method :: Maybe Method
• body :: Maybe ByteString

  The request value, where applicable. Only the first encountered request value is taken into consideration eg. "user" :> ReqBody '[JSON] Text :> ReqBody '[JSON] Int :> Get '[JSON] User will produce only a Text based request value

• contentType :: Maybe MediaType

  The requests content type. Only the first encountered content type is taken into consideration. If you're building an endpoint manually, you should enter the media type here rather than directly in headers. All implementations automatically include the content type header during benchmark configuration output.

• headers :: [Header]

  The request headers

Instances

Eq Endpoint

Defined in Servant.Benchmark.Endpoint

Methods

(==) :: Endpoint -> Endpoint -> Bool

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

Show Endpoint

Defined in Servant.Benchmark.Endpoint

Methods

showsPrec :: Int -> Endpoint -> ShowS

show :: Endpoint -> String

showList :: [Endpoint] -> ShowS

Semigroup Endpoint

Defined in Servant.Benchmark.Endpoint

Methods

(<>) :: Endpoint -> Endpoint -> Endpoint

sconcat :: NonEmpty Endpoint -> Endpoint

stimes :: Integral b => b -> Endpoint -> Endpoint

Monoid Endpoint

Defined in Servant.Benchmark.Endpoint

Methods

mempty :: Endpoint

mappend :: Endpoint -> Endpoint -> Endpoint

mconcat :: [Endpoint] -> Endpoint

pack :: Endpoint -> Endpoint

Pack an endpoint created from an API interpretation in a form ready to be serialized. - This is only useful if your are building your own output.

mkHeader :: Text -> Text -> Header

Create a Header from two Text inputs

Content Types

ctJSON :: MediaType

application/json

ctPlainText :: MediaType

text/plain ; charset=utf-8

hApplication :: ByteString

application

hJSON :: ByteString

json

hText :: ByteString

text

hPlain :: ByteString

plain

hCharset :: ByteString

charset

hUTF8 :: ByteString

utf-8