UNPKG

@loopback/docs

Version:

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

157 lines (78 loc) 2.25 kB
--- lang: en title: 'API docs: rest.restserver.route' 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.route.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; [route](./rest.restserver.route.md) ## RestServer.route() method Register a new Controller-based route. **Signature:** ```typescript route<I extends object>(verb: string, path: string, spec: OperationObject, controllerCtor: ControllerClass<I>, controllerFactory: ControllerFactory<I>, methodName: string): Binding; ``` ## Parameters <table><thead><tr><th> Parameter </th><th> Type </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> verb </td><td markdown="1"> string </td><td markdown="1"> HTTP verb of the endpoint </td></tr> <tr><td markdown="1"> path </td><td markdown="1"> string </td><td markdown="1"> URL path of the endpoint </td></tr> <tr><td markdown="1"> spec </td><td markdown="1"> OperationObject </td><td markdown="1"> The OpenAPI spec describing the endpoint (operation) </td></tr> <tr><td markdown="1"> controllerCtor </td><td markdown="1"> [ControllerClass](./rest.controllerclass.md)<!-- -->&lt;I&gt; </td><td markdown="1"> Controller constructor </td></tr> <tr><td markdown="1"> controllerFactory </td><td markdown="1"> [ControllerFactory](./rest.controllerfactory.md)<!-- -->&lt;I&gt; </td><td markdown="1"> A factory function to create controller instance </td></tr> <tr><td markdown="1"> methodName </td><td markdown="1"> string </td><td markdown="1"> The name of the controller method </td></tr> </tbody></table> **Returns:** [Binding](./context.binding.md) ## Example ```ts class MyController { greet(name: string) { return `hello ${name}`; } } app.route('get', '/greet', operationSpec, MyController, 'greet'); ```