Class OpenApiHandler

Serves the OpenAPI contract and its explorer.

The document is assembled per request rather than once at boot, because the server URL it advertises must be the host that answered: the same artefact runs behind a local port, a load balancer and an API Gateway stage, and a URL frozen at build time is wrong for at least two of them. Configuration wins when it declares servers explicitly.

Index

Constructors

Methods

Constructors

constructor

new OpenApiHandler(
dependencies: { blueprint: IBlueprint; container?: IContainer },
): OpenApiHandler
Parameters
- dependencies: { blueprint: IBlueprint; container?: IContainer }
  Auto-wired container services.
Returns OpenApiHandler

Methods

docs

docs(event: IncomingEvent): string
Serve the API explorer.
Parameters
- event: IncomingEvent
  The incoming event.
Returns string
The HTML page.

spec

spec(event: IncomingEvent): OpenApiDocument
Serve the OpenAPI JSON document.
Parameters
- event: IncomingEvent
  The incoming event.
Returns OpenApiDocument
The document.