@spailybot/moleculer-auto-openapi - v1.3.5
    Preparing search index...

    Type Alias OpenApiMixinSettings

    type OpenApiMixinSettings = {
        addServiceNameToTags?: boolean;
        assetsPath?: string;
        cacheMode?: ECacheMode;
        cacheOpenApi?: boolean;
        defaultResponseContentType?: string;
        multiPartFileFieldName?: string;
        onlyLocal?: boolean;
        openapi?: openApiServiceOpenApi;
        openApiPaths?: string | Partial<OpenApiPaths>;
        returnAssetsAsStream?: boolean;
        schemaPath?: string;
        skipUnresolvedActions?: boolean;
        summaryTemplate?: string | ((variables: TemplateVariables) => string);
        UIOauthOptions?: SwaggerUiOauthOptions;
        UIOptions?: SwaggerUiOptions;
    }
    Index

    Properties

    addServiceNameToTags? assetsPath? cacheMode? cacheOpenApi? defaultResponseContentType? multiPartFileFieldName? onlyLocal? openapi? openApiPaths? returnAssetsAsStream? schemaPath? skipUnresolvedActions? summaryTemplate? UIOauthOptions? UIOptions?

    Properties

    addServiceNameToTags?: boolean

    add the name of the services in tags ?

    false
    assetsPath?: string

    path you configured to point to open api assets

    You can use unpkg CDN by setting //unpkg.com/swagger-ui-dist[@] :

    //unpkg.com/swagger-ui-dist
    cacheMode?: ECacheMode

    allow to clear the cache when the routes are reloaded (else, they will be cleared when cache expire)

    this doesn't work without cacheOpenApi = true, or without cacher .

    next-call
    • cacheOpenApi
    • ECacheMode
    cacheOpenApi?: boolean

    add the openAPI to cache If no cacher is available, the openApi will not be cached

    true
    defaultResponseContentType?: string

    set the default response content-type, used by "response", can be overridden with parameter "response.type" on action/route level

    application/json
    multiPartFileFieldName?: string

    the name of the field holding the file (only important in documentation, change it if it collides with one of your fields)

    file
    onlyLocal?: boolean

    map only local services (on the same node) ?

    false
    openapi?: openApiServiceOpenApi

    Configure the base of the openApi Document . documentation

    openApiPaths?: string | Partial<OpenApiPaths>
    returnAssetsAsStream?: boolean

    return assets as a stream else as a buffer ?

    true
    schemaPath?: string

    path to openapi.json / to the openapi generation action

    skipUnresolvedActions?: boolean

    allow to skip unresolved actions

    true
    summaryTemplate?: string | ((variables: TemplateVariables) => string)

    summary template use variable between double accolades : {{summary}}

    string summary : the actual summary

    string action : the action name

    string autoAlias : print [autoAlias] if an auto alias

    {{summary}}\n            ({{action}}){{autoAlias}}
    UIOauthOptions?: SwaggerUiOauthOptions
    UIOptions?: SwaggerUiOptions

    set some swaggerUi options

    Settings

    Member Visibility

    On This Page

    Properties