@@ -27,6 +27,7 @@ Tested on **H2Database** v1.4.196.
27
27
username=*login for your database*
28
28
password=*password for your database*
29
29
```
30
+
30
31
* Run application with the following parameters:
31
32
* `-port [1024..49151]` - port number that will be used by server
32
33
* `-dbProps path` - **relative** path to _.properties_ file
@@ -96,7 +97,7 @@ All of the routes mentioned above provide:
96
97
97
98
#### Route-specific parameters
98
99
99
- ##### /actor
100
+ ##### /actors
100
101
101
102
* firstName
102
103
@@ -107,7 +108,7 @@ All of the routes mentioned above provide:
107
108
/actors?lastName=Williams...
108
109
109
110
110
- ##### /film
111
+ ##### /films
111
112
112
113
You can mix title and language with both minLength and maxLength.
113
114
@@ -127,45 +128,45 @@ You can mix title and language with both minLength and maxLength.
127
128
128
129
/films?language=mandarin&maxLength=99...
129
130
130
- ##### /language
131
+ ##### /languages
131
132
132
133
* name
133
134
134
- /language ?name=english...
135
+ /languages ?name=english...
135
136
136
137
## Admin routes
137
138
138
139
Non-public (accessible only to application's admins) part of the API has 2 routes:
139
- * **/user ** - provides access to users data
140
+ * **/users ** - provides access to users data
140
141
* **/admin** - provides access to mechanisms of user management
141
142
142
143
Operations on these routes don't subtract from your usage limit.
143
144
144
145
### GET Parameters
145
146
146
- ##### /user
147
+ ##### /users
147
148
148
149
* as well as in public API, you can order and paginate the results as well as get multiple results
149
150
by listing many ids
150
151
151
- /user ?page=1&perPage=5&order=asc
152
+ /users ?page=1&perPage=5&order=asc
152
153
153
154
* filter
154
155
* all (returns all users)
155
156
156
- /user ?filter=all...
157
+ /users ?filter=all...
157
158
158
159
* admin (filters by role)
159
160
160
- /user ?filter=admin...
161
+ /users ?filter=admin...
161
162
162
163
* user (filters by role)
163
164
164
- /user ?filter=user...
165
+ /users ?filter=user...
165
166
166
167
* noaccess (returns users that have exhausted their usage limit)
167
168
168
- /user ?filter=noaccess...
169
+ /users ?filter=noaccess...
169
170
170
171
171
172
##### /admin
0 commit comments