property OpenApiGeneratorOptions.exclude

Router paths to leave out of the generated document.

Matched exactly against the fully-resolved router pattern, which is router-style rather than an OpenAPI template (/todos/:id, not /todos/{id}) and INCLUDES any router.group() prefix — a route registered as get('/metrics') inside group('/internal', …) is matched only by '/internal/metrics'. Every method registered on an excluded path is omitted. An entry matching no route is silently ignored.

Type

readonly string[]

Usage

import { type OpenApiGeneratorOptions } from "openapi-plugin/src/index.ts";