Safe Haskell	None
Language	Haskell2010

Servant.API.Capture

Synopsis

Documentation

data Capture sym a Source

Capture a value from the request path under a certain type a.

Example:

           -- GET /books/:isbn
type MyApi = "books" :> Capture "isbn" Text :> Get Book

Instances

(KnownSymbol capture, FromText a, HasServer sublayout) => HasServer ((:>) * (Capture Symbol * 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 Book

server :: Server MyApi
server = getBook
  where getBook :: Text -> EitherT (Int, String) IO Book
        getBook isbn = ...

type Server ((:>) * (Capture Symbol * capture a) sublayout) = a -> Server sublayout