UNPKG

@loopback/docs

Version:
36 lines (23 loc) 1.32 kB
--- lang: en title: 'API docs: rest.restserver.mountexpressrouter' keywords: LoopBack 4.0, LoopBack 4 sidebar: lb4_sidebar permalink: /doc/en/lb4/apidocs.rest.restserver.mountexpressrouter.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; [mountExpressRouter](./rest.restserver.mountexpressrouter.md) ## RestServer.mountExpressRouter() method Mount an Express router to expose additional REST endpoints handled via legacy Express-based stack. <b>Signature:</b> ```typescript mountExpressRouter(basePath: string, router: ExpressRequestHandler, spec?: RouterSpec): void; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | | basePath | <code>string</code> | Path where to mount the router at, e.g. <code>/</code> or <code>/api</code>. | | router | <code>ExpressRequestHandler</code> | The Express router to handle the requests. | | spec | <code>RouterSpec</code> | A partial OpenAPI spec describing endpoints provided by the router. LoopBack will prepend <code>basePath</code> to all endpoints automatically. This argument is optional. You can leave it out if you don't want to document the routes. | <b>Returns:</b> `void`