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

139 lines (67 loc) • 2.33 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
--- lang: en title: 'API docs: rest-crud' keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI sidebar: lb4_sidebar editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/rest-crud permalink: /doc/en/lb4/apidocs.rest-crud.html --- <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@loopback/rest-crud](./rest-crud.md) ## rest-crud package REST API controller implementing default CRUD semantics. ## Remarks Allows LoopBack 4 applications to quickly expose models via REST API without having to implement custom controller or repository classes. ## Classes <table><thead><tr><th> Class </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> [CrudRestApiBuilder](./rest-crud.crudrestapibuilder.md) </td><td markdown="1"> </td></tr> <tr><td markdown="1"> [CrudRestComponent](./rest-crud.crudrestcomponent.md) </td><td markdown="1"> </td></tr> </tbody></table> ## Functions <table><thead><tr><th> Function </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> [defineCrudRestController(modelCtor, options)](./rest-crud.definecrudrestcontroller.md) </td><td markdown="1"> Create (define) a CRUD Controller class for the given model. </td></tr> </tbody></table> ## Interfaces <table><thead><tr><th> Interface </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> [CrudRestController](./rest-crud.crudrestcontroller.md) </td><td markdown="1"> This interface describes prototype members of the controller class returned by `defineCrudRestController`<!-- -->. </td></tr> <tr><td markdown="1"> [CrudRestControllerCtor](./rest-crud.crudrestcontrollerctor.md) </td><td markdown="1"> Constructor of the controller class returned by `defineCrudRestController`<!-- -->. </td></tr> <tr><td markdown="1"> [CrudRestControllerOptions](./rest-crud.crudrestcontrolleroptions.md) </td><td markdown="1"> Options to configure different aspects of a CRUD REST Controller. </td></tr> <tr><td markdown="1"> [ModelCrudRestApiConfig](./rest-crud.modelcrudrestapiconfig.md) </td><td markdown="1"> </td></tr> </tbody></table>