Interface ApiSettingsSchemaOpenApi

interface ApiSettingsSchemaOpenApi {
    assets?: AssetsConfig;
    cors?: CorsOptions;
    etag?: boolean | "weak" | "strong" | ETagFunction;
    http2?: boolean;
    httpServerTimeout?: number;
    internalServiceSpecialChar?: string | RegExp;
    ip?: string;
    log4XXResponses?: boolean;
    logRequest?: null | LogLevels;
    logRequestParams?: null | LogLevels;
    logResponse?: null | LogLevels;
    logResponseData?: null | LogLevels;
    logRouteRegistration?: null | LogLevels;
    onError?: ((req, res, error) => void);
    openapi?: ApiSettingsOpenApi;
    optimizeOrder?: boolean;
    path?: string;
    port?: number;
    qsOptions?: IParseOptions;
    rateLimit?: RateLimitSettings;
    rootCallOptions?: CallingOptions;
    routes?: ApiRouteSchema[];
    server?: APISettingServer;
    use?: (routeMiddleware | routeMiddlewareError)[];
}

Hierarchy

  • ApiSettingsSchema
    • ApiSettingsSchemaOpenApi

Properties

assets? cors? etag? http2? httpServerTimeout? internalServiceSpecialChar? ip? log4XXResponses? logRequest? logRequestParams? logResponse? logResponseData? logRouteRegistration? onError? openapi? optimizeOrder? path? port? qsOptions? rateLimit? rootCallOptions? routes? server? use?

Properties

Optional assets

assets?: AssetsConfig

It serves assets with the serve-static module like ExpressJS.

See

https://moleculer.services/docs/0.14/moleculer-web.html#Serve-static-files

Optional cors

cors?: CorsOptions

Cross-origin resource sharing configuration (using module cors)

Example

{
            // Configures the Access-Control-Allow-Origin CORS header.
            origin: "*", // ["http://localhost:3000", "https://localhost:4000"],
            // Configures the Access-Control-Allow-Methods CORS header.
            methods: ["GET", "OPTIONS", "POST", "PUT", "DELETE"],
            // Configures the Access-Control-Allow-Headers CORS header.
            allowedHeaders: [],
            // Configures the Access-Control-Expose-Headers CORS header.
            exposedHeaders: [],
            // Configures the Access-Control-Allow-Credentials CORS header.
            credentials: false,
            // Configures the Access-Control-Max-Age CORS header.
            maxAge: 3600
        }

See

https://moleculer.services/docs/0.14/moleculer-web.html#CORS-headers

Optional etag

etag?: boolean | "weak" | "strong" | ETagFunction

The etag option value can be false, true, weak, strong, or a custom Function

Default

settings.etag (null)

See

https://moleculer.services/docs/0.14/moleculer-web.html#ETag

Optional http2

http2?: boolean

Use HTTP2 server (experimental)

Default

false

Optional httpServerTimeout

httpServerTimeout?: number

HTTP Server Timeout

Default

null

Optional internalServiceSpecialChar

internalServiceSpecialChar?: string | RegExp

Special char for internal services
Note: RegExp type is not official

Default

"~"

Example

"~" => /~node/~action => /$node/~action

Example

/[0-9]+/g => /01234demo/hello2021 => /demo/hello `(not official)`

Optional ip

ip?: string

Exposed IP

Default

process.env.IP || "0.0.0.0"

Optional log4XXResponses

log4XXResponses?: boolean

If set to true, it will log 4xx client errors, as well

Default

false

Optional logRequest

logRequest?: null | LogLevels

Log each request (default to "info" level)

Default

"info"

Optional logRequestParams

logRequestParams?: null | LogLevels

Log the request ctx.params (default to "debug" level)

Default

"debug"

Optional logResponse

logResponse?: null | LogLevels

Log each response (default to "info" level)

Default

"info"

Optional logResponseData

logResponseData?: null | LogLevels

Log the response data (default to disable)

Default

null

Optional logRouteRegistration

logRouteRegistration?: null | LogLevels

Log the route registration/aliases related activity

Default

"info"

Optional onError

onError?: ((req, res, error) => void)

You can add route-level & global-level custom error handlers.
In handlers, you must call the res.end. Otherwise, the request is unhandled.

Type declaration

    • (req, res, error): void

    • Parameters

      • req: IncomingMessage
      • res: ServerResponse<IncomingMessage>
      • error: Error

      Returns void

See

https://moleculer.services/docs/0.14/moleculer-web.html#Error-handlers

Optional openapi

openapi?: ApiSettingsOpenApi

Optional optimizeOrder

optimizeOrder?: boolean

Optimize route order

Default

true

Optional path

path?: string

Global path prefix

Optional port

port?: number

Exposed port

Default

process.env.PORT || 3000

Optional qsOptions

qsOptions?: IParseOptions

Options passed on to qs

See

https://moleculer.services/docs/0.14/moleculer-web.html#Query-string-parameters

Optional rateLimit

rateLimit?: RateLimitSettings

The Moleculer-Web has a built-in rate limiter with a memory store.

See

https://moleculer.services/docs/0.14/moleculer-web.html#Rate-limiter

Optional rootCallOptions

rootCallOptions?: CallingOptions

CallOption for the root action api.rest

Default

null

Optional routes

routes?: ApiRouteSchema[]

Optional server

server?: APISettingServer

Used server instance. If null, it will create a new HTTP(s)(2) server
If false, it will start without server in middleware mode

Default

true

Optional use

use?: (routeMiddleware | routeMiddlewareError)[]

It supports Connect-like middlewares in global-level, route-level & alias-level.
Signature: function (req, res, next) {...}.
Signature: function (err, req, res, next) {...}.
For more info check express middleware

See

https://moleculer.services/docs/0.14/moleculer-web.html#Middlewares

Settings

Member Visibility

Theme

On This Page

assetscorsetaghttp2httpServerTimeoutinternalServiceSpecialChariplog4XXResponseslogRequestlogRequestParamslogResponselogResponseDatalogRouteRegistrationonErroropenapioptimizeOrderpathportqsOptionsrateLimitrootCallOptionsroutesserveruse