UNPKG

@loopback/docs

Version:

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

github.com/loopbackio/loopback-next/tree/master/docs

loopbackio/loopback-next

141 lines (67 loc) • 2.04 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
--- lang: en title: 'API docs: rest.controllerroute._constructor_' 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._constructor_.html --- <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@loopback/rest](./rest.md) &gt; [ControllerRoute](./rest.controllerroute.md) &gt; [(constructor)](./rest.controllerroute._constructor_.md) ## ControllerRoute.(constructor) Construct a controller based route **Signature:** ```typescript constructor(verb: string, path: string, spec: OperationObject, controllerCtor: ControllerClass<T>, controllerFactory?: ControllerFactory<T>, methodName?: string); ``` ## 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 </td></tr> <tr><td markdown="1"> path </td><td markdown="1"> string </td><td markdown="1"> http request path </td></tr> <tr><td markdown="1"> spec </td><td markdown="1"> OperationObject </td><td markdown="1"> OpenAPI operation spec </td></tr> <tr><td markdown="1"> controllerCtor </td><td markdown="1"> [ControllerClass](./rest.controllerclass.md)<!-- -->&lt;T&gt; </td><td markdown="1"> Controller class </td></tr> <tr><td markdown="1"> controllerFactory </td><td markdown="1"> [ControllerFactory](./rest.controllerfactory.md)<!-- -->&lt;T&gt; </td><td markdown="1"> _(Optional)_ A factory function to create a controller instance </td></tr> <tr><td markdown="1"> methodName </td><td markdown="1"> string </td><td markdown="1"> _(Optional)_ Controller method name, default to `x-operation-name` </td></tr> </tbody></table>