Boots.Factory.Endpoint

This module provide supports for endpoints.

Documentation

buildEndpoints

Arguments

:: (HasWeb context env, MonadMask n, MonadIO n)

=> Proxy context

Context proxy.

-> Proxy env

Environment proxy.

-> Factory n (WebEnv env context) ()

Register all endpoints provided by this package.

registerEndpoint

Arguments

:: (HasSwagger api, HasServer api context, HasWeb context env, MonadIO n, MonadMask n)

=> Text

Endpoint name, used for path, endpoints:name.

-> Proxy context

Context proxy.

-> Proxy api

Api proxy.

-> ServerT api (App env)

Api server.

-> Factory n (WebEnv env context) ()

Register endpoint, use this function to create custom endpoints.

endpointInfo :: (HasWeb context env, MonadMask n, MonadIO n) => Proxy context -> Factory n (WebEnv env context) ()

Register info endpoint.

endpointLogger :: (HasWeb context env, MonadMask n, MonadIO n) => Proxy context -> Factory n (WebEnv env context) ()

Register logger endpoint.

endpointRefresh :: (HasWeb context env, MonadMask n, MonadIO n) => Proxy context -> Factory n (WebEnv env context) ()

Register refresh endpoint.

endpointHealth :: (HasWeb context env, MonadMask n, MonadIO n) => Proxy context -> Factory n (WebEnv env context) ()

Register health endpoint.

endpointMetrics :: (HasWeb context env, MonadMask n, MonadIO n) => Proxy context -> Factory n (WebEnv env context) ()

Register metrics endpoint.