Skip to content

ManagementExpressOpenApiOptions

Defined in: management-express/src/types.ts:81

Configures adapter-served OpenAPI JSON.

The OpenAPI document itself is generated by @monque/management; this Express adapter only chooses where to serve it and which mount-specific servers metadata to attach. Set ManagementExpressRouterOptions.openApi to false to disable this route.

optional path?: string;

Defined in: management-express/src/types.ts:90

Path where OpenAPI JSON is served, relative to the Express router mount.

A leading slash is optional. For example, both openapi.json and /openapi.json serve the document at the same router-relative path.

/openapi.json


optional serverUrl?: ManagementExpressOpenApiServerUrl;

Defined in: management-express/src/types.ts:99

OpenAPI server URL for the mounted management API.

This value is written to document.servers on the response. It does not change which routes the adapter serves.

The Express mount path, based on req.baseUrl.