Servant.Validate

A package with "test suites" to help verify that your servant APIs are valid at compile-time. Currently the only property tested is that there are no duplicated paths. See README for more information on usage.

Documentation

class HasApiTree (api :: Type) where

Has a valid well-formed API Tree

Associated Types

type ToApiTree api :: ApiTree

Methods

sApiTree :: SApiTree (ToApiTree api)

Useful runtime witness of the API tree; use to inspect it with reflectApiTree. This is not used in any part of the actual validation; is just an extra treat.

Instances

(HasApiTree a, HasApiTree b) => HasApiTree (a :<|> b)

Defined in Servant.Validate

Associated Types

type ToApiTree (a :<|> b) :: ApiTree

Methods

sApiTree :: SApiTree (ToApiTree (a :<|> b))

HasApiTree api => HasApiTree (HttpVersion :> api)

Defined in Servant.Validate

Associated Types

type ToApiTree (HttpVersion :> api) :: ApiTree

Methods

sApiTree :: SApiTree (ToApiTree (HttpVersion :> api))

HasApiTree api => HasApiTree (StreamBody' mods framing ct a :> api)

Defined in Servant.Validate

Associated Types

type ToApiTree (StreamBody' mods framing ct a :> api) :: ApiTree

Methods

sApiTree :: SApiTree (ToApiTree (StreamBody' mods framing ct a :> api))

HasApiTree api => HasApiTree (ReqBody' mods ct a :> api)

Defined in Servant.Validate

Associated Types

type ToApiTree (ReqBody' mods ct a :> api) :: ApiTree

Methods

sApiTree :: SApiTree (ToApiTree (ReqBody' mods ct a :> api))

HasApiTree api => HasApiTree (RemoteHost :> api)

Defined in Servant.Validate

Associated Types

type ToApiTree (RemoteHost :> api) :: ApiTree

Methods

sApiTree :: SApiTree (ToApiTree (RemoteHost :> api))

HasApiTree api => HasApiTree (QueryParam' mods sym a :> api)

Defined in Servant.Validate

Associated Types

type ToApiTree (QueryParam' mods sym a :> api) :: ApiTree

Methods

sApiTree :: SApiTree (ToApiTree (QueryParam' mods sym a :> api))

HasApiTree api => HasApiTree (QueryParams s a :> api)

Defined in Servant.Validate

Associated Types

type ToApiTree (QueryParams s a :> api) :: ApiTree

Methods

sApiTree :: SApiTree (ToApiTree (QueryParams s a :> api))

HasApiTree api => HasApiTree (QueryFlag s :> api)

Defined in Servant.Validate

Associated Types

type ToApiTree (QueryFlag s :> api) :: ApiTree

Methods

sApiTree :: SApiTree (ToApiTree (QueryFlag s :> api))

HasApiTree api => HasApiTree (Header' mods sym a :> api)

Defined in Servant.Validate

Associated Types

type ToApiTree (Header' mods sym a :> api) :: ApiTree

Methods

sApiTree :: SApiTree (ToApiTree (Header' mods sym a :> api))

HasApiTree api => HasApiTree (IsSecure :> api)

Defined in Servant.Validate

Associated Types

type ToApiTree (IsSecure :> api) :: ApiTree

Methods

sApiTree :: SApiTree (ToApiTree (IsSecure :> api))

HasApiTree api => HasApiTree (AuthProtect tag :> api)

Defined in Servant.Validate

Associated Types

type ToApiTree (AuthProtect tag :> api) :: ApiTree

Methods

sApiTree :: SApiTree (ToApiTree (AuthProtect tag :> api))

HasApiTree api => HasApiTree (Summary s :> api)

Defined in Servant.Validate

Associated Types

type ToApiTree (Summary s :> api) :: ApiTree

Methods

sApiTree :: SApiTree (ToApiTree (Summary s :> api))

HasApiTree api => HasApiTree (Description s :> api)

Defined in Servant.Validate

Associated Types

type ToApiTree (Description s :> api) :: ApiTree

Methods

sApiTree :: SApiTree (ToApiTree (Description s :> api))

HasApiTree api => HasApiTree (Capture' mods sym a :> api)

Defined in Servant.Validate

Associated Types

type ToApiTree (Capture' mods sym a :> api) :: ApiTree

Methods

sApiTree :: SApiTree (ToApiTree (Capture' mods sym a :> api))

HasApiTree api => HasApiTree (CaptureAll sym v :> api)

Defined in Servant.Validate

Associated Types

type ToApiTree (CaptureAll sym v :> api) :: ApiTree

Methods

sApiTree :: SApiTree (ToApiTree (CaptureAll sym v :> api))

HasApiTree api => HasApiTree (BasicAuth realm a :> api)

Defined in Servant.Validate

Associated Types

type ToApiTree (BasicAuth realm a :> api) :: ApiTree

Methods

sApiTree :: SApiTree (ToApiTree (BasicAuth realm a :> api))

HasApiTree api => HasApiTree (Vault :> api)

Defined in Servant.Validate

Associated Types

type ToApiTree (Vault :> api) :: ApiTree

Methods

sApiTree :: SApiTree (ToApiTree (Vault :> api))

(KnownSymbol path, HasApiTree api) => HasApiTree (path :> api)

Defined in Servant.Validate

Associated Types

type ToApiTree (path :> api) :: ApiTree

Methods

sApiTree :: SApiTree (ToApiTree (path :> api))

(MethodString k, KnownSymbol (ToMethodString m)) => HasApiTree (Verb m s t a)

Defined in Servant.Validate

Associated Types

type ToApiTree (Verb m s t a) :: ApiTree

Methods

sApiTree :: SApiTree (ToApiTree (Verb m s t a))

class MethodString k

A type-level version of ReflectMethod.

Associated Types

type ToMethodString (x :: k) :: Symbol

Instances

MethodString Symbol

Defined in Servant.Validate

Associated Types

type ToMethodString x :: Symbol

MethodString StdMethod

Defined in Servant.Validate

Associated Types

type ToMethodString x :: Symbol

validApiTree :: forall api. (HasApiTree api, Typeable (ToApiTree api)) => Proxy api -> ValidApiTree api

The full validator. To use:

serverApi :: Proxy ServerApi
serverApi = Proxy

validServerApi :: ValidApiTree ServerApi
validServerApi = validApiTree serverApi

type ValidApiTree api = TypeRep (ToApiTree api)

To be used with validApiTree.

reflectApiTree :: forall api. (HasApiTree api, Typeable (ToApiTree api)) => ApiTreeMap

Useful utility to view the routing structure of a tree; similar to layout.

reflectApiTree_ :: TypeRep (apiTree :: ApiTree) -> ApiTreeMap

Version of reflectApiTree taking an explicit TypeRep.

data SApiTree :: ApiTree -> Type where

Constructors

SBranch :: Prod SSym ms -> Prod (Tup SSym SApiTree) ts -> SApiTree ('Branch ms ts)

Instances

Show (SApiTree api)

Defined in Servant.Validate.Internal

Methods

showsPrec :: Int -> SApiTree api -> ShowS

show :: SApiTree api -> String

showList :: [SApiTree api] -> ShowS

reflectSApiTree :: SApiTree api -> ApiTreeMap