Servant.Server.Internal

Documentation

class HasServer api where

Minimal complete definition

route

Associated Types

type ServerT api (m :: * -> *) :: *

Methods

route :: MonadSnap m => Proxy api -> Delayed m env (Server api m) -> Router m env

Instances

HasServer * Raw

Just pass the request to the underlying application and serve its response.

Example:

type MyApi = "images" :> Raw

server :: Server MyApi
server = serveDirectory "/var/www/images"

Associated Types

type ServerT Raw (api :: Raw) (m :: * -> *) :: *

Methods

route :: MonadSnap m => Proxy Raw api -> Delayed m env (Server Raw api m) -> Router m env

(HasServer * a, HasServer * b) => HasServer * ((:<|>) a b)

A server for a :<|> b first tries to match the request against the route represented by a and if it fails tries b. You must provide a request handler for each route.

type MyApi = "books" :> Get '[JSON] [Book] -- GET /books
        :<|> "books" :> ReqBody Book :> Post '[JSON] Book -- POST /books

server :: Server MyApi
server = listAllBooks :<|> postBook
  where listAllBooks = ...
        postBook book = ...

Associated Types

type ServerT ((:<|>) a b) (api :: (:<|>) a b) (m :: * -> *) :: *

Methods

route :: MonadSnap m => Proxy (a :<|> b) api -> Delayed m env (Server (a :<|> b) api m) -> Router m env

HasServer k api => HasServer * ((:>) k * RemoteHost api)

Associated Types

type ServerT ((:>) k * RemoteHost api) (api :: (:>) k * RemoteHost api) (m :: * -> *) :: *

Methods

route :: MonadSnap m => Proxy ((k :> *) RemoteHost api) api -> Delayed m env (Server ((k :> *) RemoteHost api) api m) -> Router m env

HasServer k api => HasServer * ((:>) k * IsSecure api)

Associated Types

type ServerT ((:>) k * IsSecure api) (api :: (:>) k * IsSecure api) (m :: * -> *) :: *

Methods

route :: MonadSnap m => Proxy ((k :> *) IsSecure api) api -> Delayed m env (Server ((k :> *) IsSecure api) api m) -> Router m env

HasServer k api => HasServer * ((:>) k * HttpVersion api)

Associated Types

type ServerT ((:>) k * HttpVersion api) (api :: (:>) k * HttpVersion api) (m :: * -> *) :: *

Methods

route :: MonadSnap m => Proxy ((k :> *) HttpVersion api) api -> Delayed m env (Server ((k :> *) HttpVersion api) api m) -> Router m env

(KnownSymbol path, HasServer k sublayout) => HasServer * ((:>) k Symbol path sublayout)

Make sure the incoming request starts with "/path", strip it and pass the rest of the request path to sublayout.

Associated Types

type ServerT ((:>) k Symbol path sublayout) (api :: (:>) k Symbol path sublayout) (m :: * -> *) :: *

Methods

route :: MonadSnap m => Proxy ((k :> Symbol) path sublayout) api -> Delayed m env (Server ((k :> Symbol) path sublayout) api m) -> Router m env

(AllCTUnrender list a, HasServer k sublayout) => HasServer * ((:>) k * (ReqBody * list a) sublayout)

If you use ReqBody in one of the endpoints for your API, this automatically requires your server-side handler to be a function that takes an argument of the type specified by ReqBody. The Content-Type header is inspected, and the list provided is used to attempt deserialization. If the request does not have a Content-Type header, it is treated as application/octet-stream. This lets servant worry about extracting it from the request and turning it into a value of the type you specify.

All it asks is for a FromJSON instance.

Example:

type MyApi = "books" :> ReqBody '[JSON] Book :> Post '[JSON] Book

server :: Server MyApi
server = postBook
  where postBook :: Book -> EitherT ServantErr IO Book
        postBook book = ...insert into your db...

Associated Types

type ServerT ((:>) k * (ReqBody * list a) sublayout) (api :: (:>) k * (ReqBody * list a) sublayout) (m :: * -> *) :: *

Methods

route :: MonadSnap m => Proxy ((k :> *) (ReqBody * list a) sublayout) api -> Delayed m env (Server ((k :> *) (ReqBody * list a) sublayout) api m) -> Router m env

(KnownSymbol sym, HasServer k sublayout) => HasServer * ((:>) k * (QueryFlag sym) sublayout)

If you use QueryFlag "published" in one of the endpoints for your API, this automatically requires your server-side handler to be a function that takes an argument of type Bool.

Example:

type MyApi = "books" :> QueryFlag "published" :> Get '[JSON] [Book]

server :: Server MyApi
server = getBooks
  where getBooks :: Bool -> EitherT ServantErr IO [Book]
        getBooks onlyPublished = ...return all books, or only the ones that are already published, depending on the argument...

Associated Types

type ServerT ((:>) k * (QueryFlag sym) sublayout) (api :: (:>) k * (QueryFlag sym) sublayout) (m :: * -> *) :: *

Methods

route :: MonadSnap m => Proxy ((k :> *) (QueryFlag sym) sublayout) api -> Delayed m env (Server ((k :> *) (QueryFlag sym) sublayout) api m) -> Router m env

(KnownSymbol sym, FromHttpApiData a, HasServer k sublayout) => HasServer * ((:>) k * (QueryParams * sym a) sublayout)

If you use QueryParams "authors" Text in one of the endpoints for your API, this automatically requires your server-side handler to be a function that takes an argument of type [Text].

This lets servant worry about looking up 0 or more values in the query string associated to authors and turning each of them into a value of the type you specify.

You can control how the individual values are converted from Text to your type by simply providing an instance of FromText for your type.

Example:

type MyApi = "books" :> QueryParams "authors" Text :> Get '[JSON] [Book]

server :: Server MyApi
server = getBooksBy
  where getBooksBy :: [Text] -> EitherT ServantErr IO [Book]
        getBooksBy authors = ...return all books by these authors...

Associated Types

type ServerT ((:>) k * (QueryParams * sym a) sublayout) (api :: (:>) k * (QueryParams * sym a) sublayout) (m :: * -> *) :: *

Methods

route :: MonadSnap m => Proxy ((k :> *) (QueryParams * sym a) sublayout) api -> Delayed m env (Server ((k :> *) (QueryParams * sym a) sublayout) api m) -> Router m env

(KnownSymbol sym, FromHttpApiData a, HasServer k sublayout) => HasServer * ((:>) k * (QueryParam * sym a) sublayout)

If you use QueryParam "author" Text in one of the endpoints for your API, this automatically requires your server-side handler to be a function that takes an argument of type Maybe Text.

This lets servant worry about looking it up in the query string and turning it into a value of the type you specify, enclosed in Maybe, because it may not be there and servant would then hand you Nothing.

You can control how it'll be converted from Text to your type by simply providing an instance of FromText for your type.

Example:

type MyApi = "books" :> QueryParam "author" Text :> Get '[JSON] [Book]

server :: Server MyApi
server = getBooksBy
  where getBooksBy :: Maybe Text -> EitherT ServantErr IO [Book]
        getBooksBy Nothing       = ...return all books...
        getBooksBy (Just author) = ...return books by the given author...

Associated Types

type ServerT ((:>) k * (QueryParam * sym a) sublayout) (api :: (:>) k * (QueryParam * sym a) sublayout) (m :: * -> *) :: *

Methods

route :: MonadSnap m => Proxy ((k :> *) (QueryParam * sym a) sublayout) api -> Delayed m env (Server ((k :> *) (QueryParam * sym a) sublayout) api m) -> Router m env

(KnownSymbol sym, FromHttpApiData a, HasServer k sublayout) => HasServer * ((:>) k * (Header sym a) sublayout)

If you use Header in one of the endpoints for your API, this automatically requires your server-side handler to be a function that takes an argument of the type specified by Header. This lets servant worry about extracting it from the request and turning it into a value of the type you specify.

All it asks is for a FromText instance.

Example:

newtype Referer = Referer Text
  deriving (Eq, Show, FromText, ToText)

           -- GET /view-my-referer
type MyApi = "view-my-referer" :> Header "Referer" Referer :> Get '[JSON] Referer

server :: Server MyApi
server = viewReferer
  where viewReferer :: Referer -> EitherT ServantErr IO referer
        viewReferer referer = return referer

Associated Types

type ServerT ((:>) k * (Header sym a) sublayout) (api :: (:>) k * (Header sym a) sublayout) (m :: * -> *) :: *

Methods

route :: MonadSnap m => Proxy ((k :> *) (Header sym a) sublayout) api -> Delayed m env (Server ((k :> *) (Header sym a) sublayout) api m) -> Router m env

(FromHttpApiData a, HasServer k sublayout) => HasServer * ((:>) k * (CaptureAll * capture a) sublayout)

Associated Types

type ServerT ((:>) k * (CaptureAll * capture a) sublayout) (api :: (:>) k * (CaptureAll * capture a) sublayout) (m :: * -> *) :: *

Methods

route :: MonadSnap m => Proxy ((k :> *) (CaptureAll * capture a) sublayout) api -> Delayed m env (Server ((k :> *) (CaptureAll * capture a) sublayout) api m) -> Router m env

(FromHttpApiData a, HasServer k sublayout) => HasServer * ((:>) k * (Capture * capture a) sublayout)

If you use Capture in one of the endpoints for your API, this automatically requires your server-side handler to be a function that takes an argument of the type specified by the Capture. This lets servant worry about getting it from the URL and turning it into a value of the type you specify.

You can control how it'll be converted from Text to your type by simply providing an instance of FromText for your type.

Example:

type MyApi = "books" :> Capture "isbn" Text :> Get '[JSON] Book

server :: Server MyApi
server = getBook
  where getBook :: Text -> EitherT ServantErr IO Book
        getBook isbn = ...

Associated Types

type ServerT ((:>) k * (Capture * capture a) sublayout) (api :: (:>) k * (Capture * capture a) sublayout) (m :: * -> *) :: *

Methods

route :: MonadSnap m => Proxy ((k :> *) (Capture * capture a) sublayout) api -> Delayed m env (Server ((k :> *) (Capture * capture a) sublayout) api m) -> Router m env

(AllCTRender ctypes a, ReflectMethod k1 method, KnownNat status, GetHeaders (Headers h a)) => HasServer * (Verb * k1 method status ctypes (Headers h a))

Associated Types

type ServerT (Verb * k1 method status ctypes (Headers h a)) (api :: Verb * k1 method status ctypes (Headers h a)) (m :: * -> *) :: *

Methods

route :: MonadSnap m => Proxy (Verb * k1 method status ctypes (Headers h a)) api -> Delayed m env (Server (Verb * k1 method status ctypes (Headers h a)) api m) -> Router m env

(AllCTRender ctypes a, ReflectMethod k1 method, KnownNat status) => HasServer * (Verb * k1 method status ctypes a)

Associated Types

type ServerT (Verb * k1 method status ctypes a) (api :: Verb * k1 method status ctypes a) (m :: * -> *) :: *

Methods

route :: MonadSnap m => Proxy (Verb * k1 method status ctypes a) api -> Delayed m env (Server (Verb * k1 method status ctypes a) api m) -> Router m env

type Server api m = ServerT api m

Instances

captured :: FromHttpApiData a => proxy (Capture sym a) -> Text -> Maybe a

allowedMethodHead :: Method -> Request -> Bool

allowedMethod :: Method -> Request -> Bool

processMethodRouter :: Maybe (ByteString, ByteString) -> Status -> Method -> Maybe [(HeaderName, ByteString)] -> Request -> RouteResult Response

methodCheck :: MonadSnap m => Method -> Request -> DelayedM m ()

acceptCheck :: (AllMime list, MonadSnap m) => Proxy list -> ByteString -> DelayedM m ()

methodRouter :: (AllCTRender ctypes a, MonadSnap m) => Method -> Proxy ctypes -> Status -> Delayed m env (m a) -> Router m env

methodRouterHeaders :: (GetHeaders (Headers h v), AllCTRender ctypes v, MonadSnap m) => Method -> Proxy ctypes -> Status -> Delayed m env (m (Headers h v)) -> Router m env

ct_wildcard :: ByteString

module Servant.Server.Internal.PathInfo

module Servant.Server.Internal.Router

module Servant.Server.Internal.RoutingApplication

module Servant.Server.Internal.ServantErr