@loopback/docs
Version:
Documentation files rendered at [https://loopback.io](https://loopback.io)
35 lines (24 loc) • 1.81 kB
Markdown
---
lang: en
title: 'API docs: rest.openapispecoptions'
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.openapispecoptions.html
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@loopback/rest](./rest.md) > [OpenApiSpecOptions](./rest.openapispecoptions.md)
## OpenApiSpecOptions interface
Options to customize how OpenAPI specs are served
<b>Signature:</b>
```typescript
export interface OpenApiSpecOptions
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [consolidate?](./rest.openapispecoptions.consolidate.md) | boolean | <i>(Optional)</i> Set this flag to <code>false</code> to disable OAS schema consolidation. If not set, the value defaults to <code>true</code>. |
| [disabled?](./rest.openapispecoptions.disabled.md) | true | <i>(Optional)</i> Set this flag to disable the endpoint for OpenAPI spec |
| [endpointMapping?](./rest.openapispecoptions.endpointmapping.md) | { \[key: string\]: [OpenApiSpecForm](./rest.openapispecform.md)<!-- -->; } | <i>(Optional)</i> Mapping of urls to spec forms, by default: <br> { <br> '/openapi.json': {<!-- -->version: '3.0.0', format: 'json'<!-- -->}<!-- -->, <br> '/openapi.yaml': {<!-- -->version: '3.0.0', format: 'yaml'<!-- -->}<!-- -->, <br> } |
| [servers?](./rest.openapispecoptions.servers.md) | ServerObject\[\] | <i>(Optional)</i> Configure servers for OpenAPI spec |
| [setServersFromRequest?](./rest.openapispecoptions.setserversfromrequest.md) | boolean | <i>(Optional)</i> A flag to force <code>servers</code> to be set from the http request for the OpenAPI spec |