UNPKG

@loopback/docs

Version:
43 lines (31 loc) 1.71 kB
--- lang: en title: 'API docs: rest.openapispecoptions' keywords: LoopBack 4.0, LoopBack 4 sidebar: lb4_sidebar editurl: https://github.com/strongloop/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) &gt; [@loopback/rest](./rest.md) &gt; [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) | <code>boolean</code> | 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) | <code>true</code> | Set this flag to disable the endpoint for OpenAPI spec | | [endpointMapping](./rest.openapispecoptions.endpointmapping.md) | <code>{</code><br/><code> [key: string]: OpenApiSpecForm;</code><br/><code> }</code> | Mapping of urls to spec forms, by default: ``` { '/openapi.json': {version: '3.0.0', format: 'json'}, '/openapi.yaml': {version: '3.0.0', format: 'yaml'}, } ``` | | [servers](./rest.openapispecoptions.servers.md) | <code>ServerObject[]</code> | Configure servers for OpenAPI spec | | [setServersFromRequest](./rest.openapispecoptions.setserversfromrequest.md) | <code>boolean</code> | A flag to force <code>servers</code> to be set from the http request for the OpenAPI spec |