PraugaFlexDoc.Plug (prauga_flexdoc v0.4.5)

A self-contained Plug serving FlexDoc and its version-matched renderer assets.

Example

plug PraugaFlexDoc.Plug,
  path: "/docs",
  spec_url: "/openapi.json",
  title: "My API"

See PraugaFlexDoc.Config for the full list of supported options.

Summary

Functions

call(conn, config)

Serves the documentation shell, renderer assets, and optional native execute route.

init(opts)

Initializes the plug from FlexDoc keyword options.

Functions

call(conn, config)

Serves the documentation shell, renderer assets, and optional native execute route.

Requests outside the configured FlexDoc subtree receive a 404 response. The returned connection is sent/complete for all matched and unmatched paths.

init(opts)

Initializes the plug from FlexDoc keyword options.

Returns a validated PraugaFlexDoc.Config used by call/2.