servant-auth-swagger-0.2.9.0: servant-swagger/servant-auth compatibility

Safe HaskellNone
LanguageHaskell2010

Servant.Auth.Swagger

Contents

Synopsis

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 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

data BasicAuth :: * #

Basic Auth.

data Auth (auths :: [*]) val :: [*] -> * -> * #

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

Orphan instances

(AllHasSecurity xs, HasSwagger * api) => HasSwagger * ((:>) * (Auth xs r) api) Source # 

Methods

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