Servant.Auth.Swagger

Documentation

The purpose of this package is provide the instance for 'servant-auth' combinators needed for 'servant-swagger' documentation generation.

Currently only JWT and BasicAuth are supported.

Re-export

data JWT

A JSON Web Token (JWT) in the Authorization header:

Authorization: Bearer <token>

Note that while the token is signed, it is not encrypted. Therefore do not keep in it any information you would not like the client to know.

JWTs are described in IETF's RFC 7519

Instances

HasSecurity JWT

Defined in Servant.Auth.Swagger

Methods

securityName :: Proxy JWT -> Text

securityScheme :: Proxy JWT -> SecurityScheme

data BasicAuth

Basic Auth.

Instances

HasSecurity BasicAuth

Defined in Servant.Auth.Swagger

Methods

securityName :: Proxy BasicAuth -> Text

securityScheme :: Proxy BasicAuth -> SecurityScheme

data Auth (auths :: [Type]) val

Auth [auth1, auth2] val :> api represents an API protected *either* by auth1 or auth2

Instances

HasLink sub => HasLink (Auth tag value :> sub :: Type)

A HasLink instance for Auth

Defined in Servant.Auth

Associated Types

type MkLink (Auth tag value :> sub) a

Methods

toLink :: (Link -> a) -> Proxy (Auth tag value :> sub) -> Link -> MkLink (Auth tag value :> sub) a

(AllHasSecurity xs, HasSwagger api) => HasSwagger (Auth xs r :> api :: Type)

Defined in Servant.Auth.Swagger

Methods

toSwagger :: Proxy (Auth xs r :> api) -> Swagger

type MkLink (Auth tag value :> sub :: Type) a

Defined in Servant.Auth

type MkLink (Auth tag value :> sub :: Type) a = MkLink sub a

Needed to define instances of HasSwagger

class HasSecurity x where

Methods

securityName :: Proxy x -> Text

securityScheme :: Proxy x -> SecurityScheme

Instances

HasSecurity BasicAuth

Defined in Servant.Auth.Swagger

Methods

securityName :: Proxy BasicAuth -> Text

securityScheme :: Proxy BasicAuth -> SecurityScheme

HasSecurity JWT

Defined in Servant.Auth.Swagger

Methods

securityName :: Proxy JWT -> Text

securityScheme :: Proxy JWT -> SecurityScheme

Orphan instances

(AllHasSecurity xs, HasSwagger api) => HasSwagger (Auth xs r :> api :: Type)

Methods

toSwagger :: Proxy (Auth xs r :> api) -> Swagger