Yam.Web

Documentation

mkServe :: HasServer api context => Proxy api -> Proxy context -> Context context -> Proxy c -> c -> [Middleware] -> ServerT api (App c) -> Application

mkServe' :: (HasServer api context, HasServer api' context) => (Server api -> Server api') -> Proxy api' -> Proxy api -> Proxy context -> Context context -> Proxy c -> c -> [Middleware] -> ServerT api (App c) -> Application

ask :: Monad m => ReaderT * r m r

Fetch the value of the environment.

type AppM c = ReaderT (Request, c)

type App c = AppM c Handler

type ReqApp = ReaderT Request Handler

data SwaggerConfig

Constructors

SwaggerConfig

Fields

• uiType :: SwaggerUIType
• uiPath :: String
• apiPath :: String
• enabled :: Bool
• apiTitle :: Text
• apiVersion :: Text
• contractName :: Maybe Text
• contractEmail :: Maybe Text

Instances

Show SwaggerConfig

Methods

showsPrec :: Int -> SwaggerConfig -> ShowS

show :: SwaggerConfig -> String

showList :: [SwaggerConfig] -> ShowS

FromJSON SwaggerConfig

Methods

parseJSON :: Value -> Parser SwaggerConfig

parseJSONList :: Value -> Parser [SwaggerConfig]

Default SwaggerConfig

Methods

def :: SwaggerConfig

mkServeWithSwagger :: (HasSwagger api, HasServer api context) => Proxy api -> Proxy context -> Context context -> Proxy c -> c -> [Middleware] -> SwaggerConfig -> ServerT api (App c) -> Application

prepareMiddleware :: (Vault -> IO Vault) -> Middleware

errorMiddleware :: (Request -> SomeException -> IO Response) -> Middleware

apacheMiddleware :: LoggerConfig -> Middleware

stdLoggerMiddleware :: IO Middleware

servantErrorMiddleware :: LoggerConfig -> Middleware

traceMiddleware :: Key Text -> Middleware

data YamSettings

Constructors

YamSettings

Fields

• port :: Int
• middlewares :: [Middleware]
• loggers :: LoggerConfig
• swaggers :: SwaggerConfig
• dataSources :: Maybe DataSource

Instances

Show YamSettings

Methods

showsPrec :: Int -> YamSettings -> ShowS

show :: YamSettings -> String

showList :: [YamSettings] -> ShowS

LoggerMonad Yam

Methods

loggerConfig :: Yam LoggerConfig

type Yam = App YamSettings

defaultYamSettings :: IO YamSettings

runDb :: Transaction Yam a -> Yam a

runDbIO :: YamSettings -> Transaction (ReaderT LoggerConfig IO) () -> IO ()

runServer :: (HasSwagger api, HasServer api '[YamSettings]) => YamSettings -> Proxy api -> ServerT api Yam -> IO ()

Orphan instances

MonadUnliftIO Handler

Methods

askUnliftIO :: Handler (UnliftIO Handler)

withRunInIO :: ((forall a. Handler a -> IO a) -> IO b) -> Handler b