Interface AddFromSpecificationOpts

Options for adding the routes from a oas specification.

Export

AddFromSpecificationOpts

interface AddFromSpecificationOpts {
    controllerBasePath?: string;
    fallbackControllerFunctionToPath?: boolean;
    fallbackControllerToIndex?: boolean;
    mapControllerBy?: mapControllerBy;
    provideStubs?: boolean;
    validateSpecification?: boolean;
}

Properties

controllerBasePath? fallbackControllerFunctionToPath? fallbackControllerToIndex? mapControllerBy? provideStubs? validateSpecification?

Properties

OptionalcontrollerBasePath

controllerBasePath?: string

The base path in which the controllers can be found.

OptionalfallbackControllerFunctionToPath

fallbackControllerFunctionToPath?: boolean

Should the controller function name fallback to method + path (method in lower and path in PascalCase)?

Default

true

OptionalfallbackControllerToIndex

fallbackControllerToIndex?: boolean

Should the index module (index.ts or index.js) be used as fallback?

OptionalmapControllerBy

mapControllerBy?: mapControllerBy

Specifies how to map the controller.

OptionalprovideStubs

provideStubs?: boolean

Specifies if stubs should be provided.

OptionalvalidateSpecification

validateSpecification?: boolean

Specifies if the oas-validator should be used.

Settings

Member Visibility

On This Page

Properties