Page Contents
Home > @loopback/rest > RestServerResolvedOptions
RestServerResolvedOptions interface
Signature:
export interface RestServerResolvedOptions
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| [apiExplorer](/doc/en/lb4/apidocs.rest.restserverresolvedoptions.apiexplorer.html) | [ApiExplorerOptions](/doc/en/lb4/apidocs.rest.apiexploreroptions.html) | ||
| [basePath?](/doc/en/lb4/apidocs.rest.restserverresolvedoptions.basepath.html) | string | _(Optional)_ Base path for API/static routes | |
| [cors](/doc/en/lb4/apidocs.rest.restserverresolvedoptions.cors.html) | cors.CorsOptions | ||
| [expressSettings](/doc/en/lb4/apidocs.rest.restserverresolvedoptions.expresssettings.html) | { \[name: string\]: any; } | ||
| [listenOnStart?](/doc/en/lb4/apidocs.rest.restserverresolvedoptions.listenonstart.html) | boolean | _(Optional)_ Set this flag to `false` to not listen on connections when the REST server is started. It's useful to mount a LoopBack REST server as a route to the facade Express application. If not set, the value is default to `true`. | |
| [openApiSpec](/doc/en/lb4/apidocs.rest.restserverresolvedoptions.openapispec.html) | [OpenApiSpecOptions](/doc/en/lb4/apidocs.rest.openapispecoptions.html) | ||
| [path?](/doc/en/lb4/apidocs.rest.restserverresolvedoptions.path.html) | string | _(Optional)_ | |
| [port](/doc/en/lb4/apidocs.rest.restserverresolvedoptions.port.html) | number | ||
| [requestBodyParser?](/doc/en/lb4/apidocs.rest.restserverresolvedoptions.requestbodyparser.html) | [RequestBodyParserOptions](/doc/en/lb4/apidocs.rest.requestbodyparseroptions.html) | _(Optional)_ | |
| [router](/doc/en/lb4/apidocs.rest.restserverresolvedoptions.router.html) | [RestRouterOptions](/doc/en/lb4/apidocs.rest.restrouteroptions.html) | ||
| [sequence?](/doc/en/lb4/apidocs.rest.restserverresolvedoptions.sequence.html) | [Constructor](/doc/en/lb4/apidocs.context.constructor.html)<[SequenceHandler](/doc/en/lb4/apidocs.rest.sequencehandler.html)> | _(Optional)_ |