Class Route

constructor

• new Route(
      logger: Logger,
      route: definedApiRouteSchema,
      apiService: ServiceSchema<ApiSettingsSchemaOpenApi>,
      openApiService?: ServiceSchema<
          OpenApiMixinSettings,
          Record<string, any>,
          Record<string, any>,
          Service<OpenApiMixinSettings> & Record<string, any>,
      >,
      skipUnresolvedActions?: boolean,
  ): Route

  Parameters

  • logger: Logger
  • route: definedApiRouteSchema
  • apiService: ServiceSchema<ApiSettingsSchemaOpenApi>
  • OptionalopenApiService: ServiceSchema<
        OpenApiMixinSettings,
        Record<string, any>,
        Record<string, any>,
        Service<OpenApiMixinSettings> & Record<string, any>,
    >
  • skipUnresolvedActions: boolean = true

  Returns Route

Readonlyaliases

ReadonlyapiService

ReadonlyautoAliases

Optional ReadonlybodyParsers

Optional ReadonlybusboyConfig

Optional Readonlyopenapi

Optional ReadonlyopenApiService

Readonlypath

searchAlias

• searchAlias(alias: routeAlias): Alias | undefined

  Parameters

  • alias: routeAlias

  Returns Alias | undefined

StaticformatPath

• formatPath(
      routePath: string,
      apiService: ServiceSchema<ApiSettingsSchemaOpenApi>,
  ): string

  Parameters

  • routePath: string
  • apiService: ServiceSchema<ApiSettingsSchemaOpenApi>

  Returns string