@loopback/docs
Version:
Documentation files rendered at [https://loopback.io](https://loopback.io)
225 lines (103 loc) • 2.98 kB
Markdown
---
lang: en
title: 'API docs: rest.controllerroute'
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.controllerroute.html
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@loopback/rest](./rest.md) > [ControllerRoute](./rest.controllerroute.md)
## ControllerRoute class
A route backed by a controller
**Signature:**
```typescript
export declare class ControllerRoute<T extends object> extends BaseRoute
```
**Extends:** [BaseRoute](./rest.baseroute.md)
## Constructors
<table><thead><tr><th>
Constructor
</th><th>
Modifiers
</th><th>
Description
</th></tr></thead>
<tbody><tr><td markdown="1">
[(constructor)(verb, path, spec, controllerCtor, controllerFactory, methodName)](./rest.controllerroute._constructor_.md)
</td><td markdown="1">
</td><td markdown="1">
Construct a controller based route
</td></tr>
</tbody></table>
## Properties
<table><thead><tr><th>
Property
</th><th>
Modifiers
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td markdown="1">
[\_controllerCtor](./rest.controllerroute._controllerctor.md)
</td><td markdown="1">
`protected`
`readonly`
</td><td markdown="1">
[ControllerClass](./rest.controllerclass.md)<!-- --><T>
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[\_controllerFactory](./rest.controllerroute._controllerfactory.md)
</td><td markdown="1">
`protected`
`readonly`
</td><td markdown="1">
[ControllerFactory](./rest.controllerfactory.md)<!-- --><T>
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[\_controllerName](./rest.controllerroute._controllername.md)
</td><td markdown="1">
`protected`
`readonly`
</td><td markdown="1">
string
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[\_methodName](./rest.controllerroute._methodname.md)
</td><td markdown="1">
`protected`
`readonly`
</td><td markdown="1">
string
</td><td markdown="1">
</td></tr>
</tbody></table>
## Methods
<table><thead><tr><th>
Method
</th><th>
Modifiers
</th><th>
Description
</th></tr></thead>
<tbody><tr><td markdown="1">
[describe()](./rest.controllerroute.describe.md)
</td><td markdown="1">
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[invokeHandler(requestContext, args)](./rest.controllerroute.invokehandler.md)
</td><td markdown="1">
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[updateBindings(requestContext)](./rest.controllerroute.updatebindings.md)
</td><td markdown="1">
</td><td markdown="1">
</td></tr>
</tbody></table>