Options
All
  • Public
  • Public/Protected
  • All
Menu

Information for generating a Swagger document (path definition).

Hierarchy

  • SwaggerInfo

Index

Properties

Optional controller

controller: Controller<unknown>

The underlying controller.

Optional controllerMethod

controllerMethod: Function

The underlying controller method.

Optional controllerRootPath

controllerRootPath: string

The controller's root path.

groupedRouterMethods

groupedRouterMethods: {}

List of router methods, grouped by paths.

Type declaration

  • [path: string]: string[]

Optional methods

methods: string[]

List of supported methods.

Optional middlewares

middlewares: RequestHandler[]

The middlewares, which are defined for that route.

Optional options

Custom options.

pathDefinition

pathDefinition: any

The path definition.

Generated using TypeDoc