betty.extensions.http_api_doc module

Integrate Betty with Swagger UI.

final class betty.extensions.http_api_doc.HttpApiDoc

Bases: EntryPointProvider

The http-api-doc extension plugin. Display the HTTP API documentation in a user-friendly way using Swagger UI.

Plugin ID	http-api-doc
Class	HttpApiDoc
Configuration	not configurable

webpack_entry_point_cache_keys() → Sequence[str]

Get the keys that make a Webpack build for this provider unique.

Providers that can be cached regardless may return ().

classmethod webpack_entry_point_directory() → StrPath

Get the path to the directory with the entry point assets.

The directory must include at least a package.json and main.ts.