Documentation

Generate a OpenApi specification for a servant API.

To generate OpenApi specification, your data types need ToParamSchema and/or ToSchema instances.

ToParamSchema is used for Capture, QueryParam and Header. ToSchema is used for ReqBody and response data types.

You can easily derive those instances via Generic. For more information, refer to openapi3 documentation.

Example:

newtype Username = Username String deriving (Generic, ToText)

instance ToParamSchema Username

data User = User
  { username :: Username
  , fullname :: String
  } deriving (Generic)

instance ToJSON User
instance ToSchema User

type MyAPI = QueryParam "username" Username :> Get '[JSON] User

myOpenApi :: OpenApi
myOpenApi = toOpenApi (Proxy :: Proxy MyAPI)

All operations of sub API. This is similar to operationsOf but ensures that operations indeed belong to the API at compile time.

Make a singleton OpenApi spec (with only one endpoint). For endpoints with no content see mkEndpointNoContent.

Make a singletone OpenApi spec (with only one endpoint) and with no content schema.

Like mkEndpoint but with explicit schema reference. Unlike mkEndpoint this function does not update definitions.

Add parameter to every operation in the spec.

Add RequestBody to every operations in the spec.

Format given text as inline code in Markdown.

Methods, available for OpenApi.