Added REST admin controller

This commit is contained in:
MatteoF96
2022-09-22 16:06:44 +02:00
parent b680784f66
commit ced062856f
8 changed files with 547 additions and 2 deletions

View File

@ -317,4 +317,37 @@ Possible array keys:
- special: minimum number of special characters;
- min: minimum number of characters (= minimum length).
#### authenticatorClass (type: `string`, default: `yii\filters\auth\QueryParamAuth`)
Which class to use as authenticator for REST API.
Possible values ([official documentation](https://www.yiiframework.com/doc/guide/2.0/en/rest-authentication)):
- `HttpBasicAuth`
- `HttpBearerAuth`
- `QueryParamAuth`.
Default value = `yii\filters\auth\QueryParamAuth` class, therefore access tokens are sent as query parameter; for instance: `https://example.com/users?access-token=xxxxxxxx`.
#### adminRestPrefix (type: `string`, default: `user/api/v1`)
Route prefix for REST admin controller.
#### adminRestRoutes (type `array`)
Routes for REST admin controller.
Default value:
```php
[
'GET,HEAD users' => 'admin/index',
'POST users' => 'admin/create',
'PUT,PATCH users/<id>' => 'admin/update',
'GET,HEAD users/<id>' => 'admin/view',
'DELETE users/<id>' => 'admin/delete',
'users/<action>/<id>' => 'admin/<action>',
'users/<id>' => 'admin/options',
'users' => 'admin/options',
];
```
© [2amigos](http://www.2amigos.us/) 2013-2019