Function SwaggerCustomizer

SwaggerCustomizer(
closure: (props: SwaggerCustomizer.IProps) => unknown,
): MethodDecorator
Swagger customization decorator.

SwaggerCustomizer is a method decorator function which can used for customizing the swagger data with npx nestia swagger command. Furthermore, it is possible to add plugin properties starting with x- characters.

In other words, this decorator function does not affect to the runtime, but only for the swagger data customization.
Parameters
- closure: (props: SwaggerCustomizer.IProps) => unknown
  Callback function which can customize the swagger data
Returns MethodDecorator
Method decorator

Author
Jeongho Nam - https://github.com/samchon

Evidence
contracts/common.md#principled-implementation Each use appends the closure to an array of metadata owned by the method, created on first use, so several customizers on one method run in order.

Evidence
contracts/common.md#clear-and-simple-design One decorator function with one metadata list per method.

Evidence
contracts/common.md#prohibited-implementation-shortcuts It uses the reflect metadata API; the closure is the caller's.

Evidence
contracts/common.md#meaningful-documentation The comment documents that the closure receives the document, the operation, and lookup helpers.

Evidence Exclude
contracts/portability.md#os-neutral-implementation The callback and endpoint accessors edit an OpenAPI document; their path fields are HTTP routes rather than native file identities.
- Defined in decorators/SwaggerCustomizer.ts:22

Function SwaggerCustomizer

Parameters

Returns MethodDecorator

Author

Evidence

Evidence

Evidence

Evidence

Evidence Exclude

Settings