UNPKG

@loopback/docs

Version:

Documentation files rendered at [https://loopback.io](https://loopback.io)

37 lines (24 loc) 1.14 kB
--- lang: en title: 'API docs: rest.restserver.addopenapispecendpoint' 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.restserver.addopenapispecendpoint.html --- <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@loopback/rest](./rest.md) &gt; [RestServer](./rest.restserver.md) &gt; [addOpenApiSpecEndpoint](./rest.restserver.addopenapispecendpoint.md) ## RestServer.addOpenApiSpecEndpoint() method Add a new non-controller endpoint hosting a form of the OpenAPI spec. <b>Signature:</b> ```typescript addOpenApiSpecEndpoint(path: string, form: OpenApiSpecForm, router?: express.Router): void; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | | path | string | Path at which to host the copy of the OpenAPI | | form | [OpenApiSpecForm](./rest.openapispecform.md) | Form that should be rendered from that path | | router | express.Router | | <b>Returns:</b> void