Interface IProps

Properties for the SwaggerCustomizer decorator.

SwaggerCustomizer.IProps is a type for the closure parameter of the SwaggerCustomizer decorator. It's a callback function which can customize the swagger data.

interface IProps {
    method: string;
    path: string;
    route: IOperation;
    swagger: IDocument;
    at(func: Function): ISwaggerEndpoint | undefined;
    get(accessor: IAccessor): IOperation | undefined;
}

Index

Properties

method path route swagger

Methods

at get

Properties

method

method: string

Method of the route.

path

path: string

Path of the route.

route

route: IOperation

Route data.

swagger

swagger: IDocument

Swagger data.

Methods

at

at(func: Function): ISwaggerEndpoint | undefined
Get neighbor endpoint data through the controller method.
Parameters
- func: Function
  Controller method to find the neighbor endpoint
Returns ISwaggerEndpoint | undefined
Neighbor endpoint data
- Defined in decorators/SwaggerCustomizer.ts:72

get

get(accessor: IAccessor): IOperation | undefined
Get neighbor route data.
Parameters
- accessor: IAccessor
  Accessor for getting neighbor route data
Returns IOperation | undefined
Neighbor route data
- Defined in decorators/SwaggerCustomizer.ts:80

Interface IProps

Index

Properties

Methods

Properties

method

path

route

swagger

Methods

at

Parameters

Returns ISwaggerEndpoint | undefined

get

Parameters

Returns IOperation | undefined

Settings

On This Page