@loopback/docs
Version:
Documentation files rendered at [https://loopback.io](https://loopback.io)
245 lines (108 loc) • 3.63 kB
Markdown
---
lang: en
title: 'API docs: rest.restserverresolvedoptions'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/rest
permalink: /doc/en/lb4/apidocs.rest.restserverresolvedoptions.html
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@loopback/rest](./rest.md) > [RestServerResolvedOptions](./rest.restserverresolvedoptions.md)
## RestServerResolvedOptions interface
**Signature:**
```typescript
export interface RestServerResolvedOptions
```
## Properties
<table><thead><tr><th>
Property
</th><th>
Modifiers
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td markdown="1">
[apiExplorer](./rest.restserverresolvedoptions.apiexplorer.md)
</td><td markdown="1">
</td><td markdown="1">
[ApiExplorerOptions](./rest.apiexploreroptions.md)
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[basePath?](./rest.restserverresolvedoptions.basepath.md)
</td><td markdown="1">
</td><td markdown="1">
string
</td><td markdown="1">
_(Optional)_ Base path for API/static routes
</td></tr>
<tr><td markdown="1">
[cors](./rest.restserverresolvedoptions.cors.md)
</td><td markdown="1">
</td><td markdown="1">
cors.CorsOptions
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[expressSettings](./rest.restserverresolvedoptions.expresssettings.md)
</td><td markdown="1">
</td><td markdown="1">
{ \[name: string\]: any; }
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[listenOnStart?](./rest.restserverresolvedoptions.listenonstart.md)
</td><td markdown="1">
</td><td markdown="1">
boolean
</td><td markdown="1">
_(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`<!-- -->.
</td></tr>
<tr><td markdown="1">
[openApiSpec](./rest.restserverresolvedoptions.openapispec.md)
</td><td markdown="1">
</td><td markdown="1">
[OpenApiSpecOptions](./rest.openapispecoptions.md)
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[path?](./rest.restserverresolvedoptions.path.md)
</td><td markdown="1">
</td><td markdown="1">
string
</td><td markdown="1">
_(Optional)_
</td></tr>
<tr><td markdown="1">
[port](./rest.restserverresolvedoptions.port.md)
</td><td markdown="1">
</td><td markdown="1">
number
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[requestBodyParser?](./rest.restserverresolvedoptions.requestbodyparser.md)
</td><td markdown="1">
</td><td markdown="1">
[RequestBodyParserOptions](./rest.requestbodyparseroptions.md)
</td><td markdown="1">
_(Optional)_
</td></tr>
<tr><td markdown="1">
[router](./rest.restserverresolvedoptions.router.md)
</td><td markdown="1">
</td><td markdown="1">
[RestRouterOptions](./rest.restrouteroptions.md)
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[sequence?](./rest.restserverresolvedoptions.sequence.md)
</td><td markdown="1">
</td><td markdown="1">
[Constructor](./context.constructor.md)<!-- --><[SequenceHandler](./rest.sequencehandler.md)<!-- -->>
</td><td markdown="1">
_(Optional)_
</td></tr>
</tbody></table>