Servant.API.Capture

Documentation

type Capture = Capture' '[]

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

Example:

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

data Capture' (mods :: [*]) (sym :: Symbol) (a :: *)

Capture which can be modified. For example with Description.

Instances

(ToHttpApiData v, HasLink sub) => HasLink (Capture' mods sym v :> sub :: Type)

Defined in Servant.Links

Associated Types

type MkLink (Capture' mods sym v :> sub) a :: Type

Methods

toLink :: (Link -> a) -> Proxy (Capture' mods sym v :> sub) -> Link -> MkLink (Capture' mods sym v :> sub) a

type MkLink (Capture' mods sym v :> sub :: Type) a

Defined in Servant.Links

type MkLink (Capture' mods sym v :> sub :: Type) a = v -> MkLink sub a

data CaptureAll (sym :: Symbol) (a :: *)

Capture all remaining values from the request path under a certain type a.

Example:

>>> -- GET /src/*
>>> type MyAPI = "src" :> CaptureAll "segments" Text :> Get '[JSON] SourceFile

Instances

(ToHttpApiData v, HasLink sub) => HasLink (CaptureAll sym v :> sub :: Type)

Defined in Servant.Links

Associated Types

type MkLink (CaptureAll sym v :> sub) a :: Type

Methods

toLink :: (Link -> a) -> Proxy (CaptureAll sym v :> sub) -> Link -> MkLink (CaptureAll sym v :> sub) a

type MkLink (CaptureAll sym v :> sub :: Type) a

Defined in Servant.Links

type MkLink (CaptureAll sym v :> sub :: Type) a = [v] -> MkLink sub a