UNPKG

@loopback/docs

Version:

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

97 lines (48 loc) 1.51 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. **Signature:** ```typescript addOpenApiSpecEndpoint(path: string, form: OpenApiSpecForm, router?: express.Router): void; ``` ## Parameters <table><thead><tr><th> Parameter </th><th> Type </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> path </td><td markdown="1"> string </td><td markdown="1"> Path at which to host the copy of the OpenAPI </td></tr> <tr><td markdown="1"> form </td><td markdown="1"> [OpenApiSpecForm](./rest.openapispecform.md) </td><td markdown="1"> Form that should be rendered from that path </td></tr> <tr><td markdown="1"> router </td><td markdown="1"> express.Router </td><td markdown="1"> _(Optional)_ </td></tr> </tbody></table> **Returns:** void