Type Alias ControllerRouteConfiguration

The configuration for a controller route.

type ControllerRouteConfiguration = {
    controllerMethod: string;
    httpMethod: HttpMethod;
    route: Route;
    versions: SupportedVersionsOptions | undefined;
}

Index

Properties

controllerMethod httpMethod route versions

Properties

controllerMethod

controllerMethod: string

The name of the method on the controller that is responsible for handling requests to the endpoint.

httpMethod

httpMethod: HttpMethod

The http method used by the route.

route

route: Route

The actual route under which the endpoint should be reached.

versions

versions: SupportedVersionsOptions | undefined

Configuration on what versions are supported. Defaults to '^latest'.