Yam.Web.Swagger

Documentation

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, API api) => YamSettings -> Proxy api -> ServerT api App -> Application

data YamSettings

Constructors

YamSettings

Fields

• vault :: Vault
• middlewares :: [Middleware]
• swaggers :: SwaggerConfig

defaultYamSettings :: IO YamSettings