Type Alias ApiSettingsSchema

ApiSettingsSchema: CommonSettingSchema & {
    assets?: AssetsConfig;
    http2?: boolean;
    httpServerTimeout?: number;
    internalServiceSpecialChar?: string | RegExp;
    ip?: string;
    log4XXResponses?: boolean;
    logRequest?: LogLevels | null;
    logRequestParams?: LogLevels | null;
    logResponse?: LogLevels | null;
    logResponseData?: LogLevels | null;
    logRouteRegistration?: LogLevels | null;
    optimizeOrder?: boolean;
    path?: string;
    port?: number;
    qsOptions?: IParseOptions;
    rootCallOptions?: CallingOptions;
    routes?: MoleculerWebTypes.ApiRouteSchema[];
    server?: boolean;
    [k: string]: any;
}

Type declaration

[k: string]: any
for extra setting's keys
Optionalassets?: AssetsConfig
It serves assets with the serve-static module like ExpressJS.

See
https://moleculer.services/docs/0.14/moleculer-web.html#Serve-static-files
Optionalhttp2?: boolean
Use HTTP2 server (experimental)
Default
```
false
```
OptionalhttpServerTimeout?: number
HTTP Server Timeout
Default
```
null
```
OptionalinternalServiceSpecialChar?: 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)`
```
Optionalip?: string
Exposed IP
Default
```
process.env.IP || "0.0.0.0"
```
Optionallog4XXResponses?: boolean
If set to true, it will log 4xx client errors, as well
Default
```
false
```
OptionallogRequest?: LogLevels | null
Log each request (default to "info" level)
Default
```
"info"
```
OptionallogRequestParams?: LogLevels | null
Log the request ctx.params (default to "debug" level)
Default
```
"debug"
```
OptionallogResponse?: LogLevels | null
Log each response (default to "info" level)
Default
```
"info"
```
OptionallogResponseData?: LogLevels | null
Log the response data (default to disable)
Default
```
null
```
OptionallogRouteRegistration?: LogLevels | null
Log the route registration/aliases related activity
Default
```
"info"
```
OptionaloptimizeOrder?: boolean
Optimize route order
Default
```
true
```
Optionalpath?: string
Global path prefix
Optionalport?: number
Exposed port
Default
```
process.env.PORT || 3000
```
OptionalqsOptions?: IParseOptions
Options passed on to qs

See
https://moleculer.services/docs/0.14/moleculer-web.html#Query-string-parameters
OptionalrootCallOptions?: CallingOptions
CallOption for the root action api.rest
Default
```
null
```
Optionalroutes?: MoleculerWebTypes.ApiRouteSchema[]
Gateway routes
Default
```
[]
```
Optionalserver?: boolean
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
```

Type Alias ApiSettingsSchema

Type declaration

[k: string]: any

Optionalassets?: AssetsConfig

See

Optionalhttp2?: boolean

Default

OptionalhttpServerTimeout?: number

Default

OptionalinternalServiceSpecialChar?: string | RegExp

Default

Example

Example

Optionalip?: string

Default

Optionallog4XXResponses?: boolean

Default

OptionallogRequest?: LogLevels | null

Default

OptionallogRequestParams?: LogLevels | null

Default

OptionallogResponse?: LogLevels | null

Default

OptionallogResponseData?: LogLevels | null

Default

OptionallogRouteRegistration?: LogLevels | null

Default

OptionaloptimizeOrder?: boolean

Default

Optionalpath?: string

Optionalport?: number

Default

OptionalqsOptions?: IParseOptions

See

OptionalrootCallOptions?: CallingOptions

Default

Optionalroutes?: MoleculerWebTypes.ApiRouteSchema[]

Default

Optionalserver?: boolean

Default

Settings

`Optional`assets?: AssetsConfig

`Optional`http2?: boolean

`Optional`httpServerTimeout?: number

`Optional`internalServiceSpecialChar?: string | RegExp

`Optional`ip?: string

`Optional`log4XXResponses?: boolean

`Optional`logRequest?: LogLevels | null

`Optional`logRequestParams?: LogLevels | null

`Optional`logResponse?: LogLevels | null

`Optional`logResponseData?: LogLevels | null

`Optional`logRouteRegistration?: LogLevels | null

`Optional`optimizeOrder?: boolean

`Optional`path?: string

`Optional`port?: number

`Optional`qsOptions?: IParseOptions

`Optional`rootCallOptions?: CallingOptions

`Optional`routes?: MoleculerWebTypes.ApiRouteSchema[]

`Optional`server?: boolean