Interface IControllerRouteOptions

Options for a controller route without a body.

interface IControllerRouteOptions {
    authorize?: Nilable<AuthorizeArgumentValue>;
    deprecated?: Nilable<ControllerRouteDeprecatedValue>;
    documentation?: Nilable<{
        callbacks?: {
            [callback: string]: ReferenceObject | CallbackObject;
        };
        deprecated?: boolean;
        description?: string;
        externalDocs?: ExternalDocumentationObject;
        operationId?: string;
        parameters?: (ReferenceObject | ParameterObject)[];
        requestBody?: ReferenceObject | RequestBodyObject;
        responses: ResponsesObject;
        security?: SecurityRequirementObject[];
        servers?: ServerObject[];
        summary?: string;
        tags?: string[];
    }>;
    noAutoEnd?: Nilable<boolean>;
    noQueryParams?: Nilable<boolean>;
    onError?: Nilable<HttpErrorHandler>;
    onValidationWithDocumentationFailed?: Nilable<JsonSchemaValidationFailedHandler>;
    parameterFormat?: Nilable<ControllerParameterFormat>;
    path?: Nilable<string>;
    serializer?: Nilable<ResponseSerializer<any>>;
    use?: Nilable<HttpMiddleware | HttpMiddleware[]>;
    validateWithDocumentation?: Nilable<boolean>;
}

Hierarchy

Properties

authorize? deprecated? documentation? noAutoEnd? noQueryParams? onError? onValidationWithDocumentationFailed? parameterFormat? path? serializer? use? validateWithDocumentation?

Properties

Optional authorize

authorize?: Nilable<AuthorizeArgumentValue>

Custom 'authorize' options.

Optional deprecated

deprecated?: Nilable<ControllerRouteDeprecatedValue>

Indicates, if route is deprecated or not.

Optional documentation

documentation?: Nilable<{
    callbacks?: {
        [callback: string]: ReferenceObject | CallbackObject;
    };
    deprecated?: boolean;
    description?: string;
    externalDocs?: ExternalDocumentationObject;
    operationId?: string;
    parameters?: (ReferenceObject | ParameterObject)[];
    requestBody?: ReferenceObject | RequestBodyObject;
    responses: ResponsesObject;
    security?: SecurityRequirementObject[];
    servers?: ServerObject[];
    summary?: string;
    tags?: string[];
}>

Optional Swagger documentation.

Type declaration

Optional noAutoEnd

noAutoEnd?: Nilable<boolean>

Should do no automatic response.end() call.

Default

false

Optional noQueryParams

noQueryParams?: Nilable<boolean>

Indicates, that query parameters should NOT be parsed.

Optional onError

onError?: Nilable<HttpErrorHandler>

The custom error handler.

Optional onValidationWithDocumentationFailed

onValidationWithDocumentationFailed?: Nilable<JsonSchemaValidationFailedHandler>

The handler, that is executed, when object validation with Swagger documentation failed.

Optional parameterFormat

parameterFormat?: Nilable<ControllerParameterFormat>

The custom URL parameter format (only for the route).

@default: ControllerParameterFormat.Default

Optional path

path?: Nilable<string>

The custom path.

Optional serializer

serializer?: Nilable<ResponseSerializer<any>>

The custom serializer.

Optional use

use?: Nilable<HttpMiddleware | HttpMiddleware[]>

One or more middlewares for the route.

Optional validateWithDocumentation

validateWithDocumentation?: Nilable<boolean>

Validate request data with schema in documentation or not.

Default

false

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc