Documentation ¶
Overview ¶
Package caddy provides a handler for Caddy Server (https://caddyserver.com/) allowing to turn any web API in a one supporting the Vulcain protocol.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Vulcain ¶
type Vulcain struct { // Path to an OpenAPI file documenting relations between resources (for non-hypermedia APIs) OpenAPIFile string `json:"openapi_file,omitempty"` // Maximum number of resources to push MaxPushes int `json:"max_pushes,omitempty"` // To eable 103 Early Hints responses EarlyHints bool `json:"early_hints,omitempty"` ApiUrl string `json:"api_url,omitempty"` // contains filtered or unexported fields }
Vulcain add suport for the Vulcain protocol (fast and idiomatic client-driven REST APIs) as a Caddy module.
func (Vulcain) CaddyModule ¶
func (Vulcain) CaddyModule() caddy.ModuleInfo
CaddyModule returns the Caddy module information.
func (*Vulcain) UnmarshalCaddyfile ¶
UnmarshalCaddyfile sets up the handler from Caddyfile tokens. Syntax:
vulcain { # path to the OpenAPI file describing the relations (for non-hypermedia APIs) openapi_file <path> # Maximum number of pushes to do (-1 for unlimited) max_pushes -1 }
Click to show internal directories.
Click to hide internal directories.