From a56aab30609e6ab4029196c28dad18a4c3e0d13c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=B4=94=E4=BA=AE?= Date: Mon, 19 Nov 2018 10:31:06 +0800 Subject: [PATCH] Update rest-controllers.md --- docs/guide-zh-CN/rest-controllers.md | 64 ++++++++++++++-------------- 1 file changed, 32 insertions(+), 32 deletions(-) diff --git a/docs/guide-zh-CN/rest-controllers.md b/docs/guide-zh-CN/rest-controllers.md index eea4e8dc02..ea65c5eae2 100644 --- a/docs/guide-zh-CN/rest-controllers.md +++ b/docs/guide-zh-CN/rest-controllers.md @@ -6,10 +6,10 @@ Yii 提供两个控制器基类来简化创建RESTful 操作的工作:[[yii\rest\Controller]] 和 [[yii\rest\ActiveController]], -两个类的差别是后者提供一系列将资源处理成[Active Record](db-active-record.md)的操作。 -因此如果使用[Active Record](db-active-record.md)内置的操作会比较方便,可考虑将控制器类 -继承[[yii\rest\ActiveController]], -它会让你用最少的代码完成强大的RESTful APIs。 +两个类的差别是后者提供一系列将资源处理成 [Active Record](db-active-record.md) 的操作。 +因此如果使用 [Active Record](db-active-record.md) 内置的操作会比较方便,可考虑将控制器类 +继承 [[yii\rest\ActiveController]], +它会让你用最少的代码完成强大的 RESTful APIs。 [[yii\rest\Controller]] 和 [[yii\rest\ActiveController]] 提供以下功能, 一些功能在后续章节详细描述: @@ -21,7 +21,7 @@ Yii 提供两个控制器基类来简化创建RESTful [[yii\rest\ActiveController]] 额外提供一下功能: -* 一系列常用动作: `index`, `view`, `create`, `update`, `delete`, `options`; +* 一系列常用动作:`index`,`view`,`create`,`update`,`delete`,`options`; * 对动作和资源进行用户认证。 @@ -29,12 +29,12 @@ Yii 提供两个控制器基类来简化创建RESTful 当创建一个新的控制器类,控制器类的命名最好使用资源名称的单数格式, 例如,提供用户信息的控制器 -可命名为`UserController`。 +可命名为 `UserController`。 创建新的操作和Web应用中创建操作类似, -唯一的差别是Web应用中调用`render()`方法渲染一个视图作为返回值, -对于RESTful操作直接返回数据, -[[yii\rest\Controller::serializer|serializer]] 和[[yii\web\Response|response object]] +唯一的差别是Web应用中调用 `render()` 方法渲染一个视图作为返回值, +对于 RESTful 操作直接返回数据, +[[yii\rest\Controller::serializer|serializer]] 和 [[yii\web\Response|response object]] 会处理原始数据到请求格式的转换,例如 ```php @@ -47,20 +47,20 @@ public function actionView($id) ## 过滤器 -[[yii\rest\Controller]]提供的大多数RESTful API功能通过[过滤器](structure-filters.md)实现。 +[[yii\rest\Controller]] 提供的大多数 RESTful API 功能通过[过滤器](structure-filters.md)实现。 特别是以下过滤器会按顺序执行: -* [[yii\filters\ContentNegotiator|contentNegotiator]]: 支持内容协商, - 在 [响应格式化](rest-response-formatting.md) 一节描述; -* [[yii\filters\VerbFilter|verbFilter]]: 支持HTTP 方法验证; -* [[yii\filters\auth\AuthMethod|authenticator]]: 支持用户认证, - 在[认证](rest-authentication.md)一节描述; -* [[yii\filters\RateLimiter|rateLimiter]]: 支持频率限制, +* [[yii\filters\ContentNegotiator|contentNegotiator]]:支持内容协商, + 在 [响应格式化](rest-response-formatting.md) 一节描述; +* [[yii\filters\VerbFilter|verbFilter]]:支持 HTTP 方法验证; +* [[yii\filters\auth\AuthMethod|authenticator]]:支持用户认证, + 在[认证](rest-authentication.md)一节描述; +* [[yii\filters\RateLimiter|rateLimiter]]:支持频率限制, 在[频率限制](rest-rate-limiting.md) 一节描述。 -这些过滤器都在[[yii\rest\Controller::behaviors()|behaviors()]]方法中声明, +这些过滤器都在 [[yii\rest\Controller::behaviors()|behaviors()]] 方法中声明, 可覆盖该方法来配置单独的过滤器,禁用某个或增加你自定义的过滤器。 -例如,如果你只想用HTTP 基础认证,可编写如下代码: +例如,如果你只想用 HTTP 基础认证,可编写如下代码: ```php use yii\filters\auth\HttpBasicAuth; @@ -113,23 +113,23 @@ public function behaviors() ## 继承 `ActiveController` -如果你的控制器继承[[yii\rest\ActiveController]], -应设置[[yii\rest\ActiveController::modelClass|modelClass]] 属性 -为通过该控制器返回给用户的资源类名,该类必须继承[[yii\db\ActiveRecord]]。 +如果你的控制器继承 [[yii\rest\ActiveController]], +应设置 [[yii\rest\ActiveController::modelClass|modelClass]] 属性 +为通过该控制器返回给用户的资源类名,该类必须继承 [[yii\db\ActiveRecord]]。 ### 自定义动作 [[yii\rest\ActiveController]] 默认提供一下动作: -* [[yii\rest\IndexAction|index]]:按页列出资源; -* [[yii\rest\ViewAction|view]]:返回指定资源的详情; -* [[yii\rest\CreateAction|create]]:创建新的资源; -* [[yii\rest\UpdateAction|update]]:更新一个存在的资源; -* [[yii\rest\DeleteAction|delete]]:删除指定的资源; +* [[yii\rest\IndexAction|index]]:按页列出资源; +* [[yii\rest\ViewAction|view]]:返回指定资源的详情; +* [[yii\rest\CreateAction|create]]:创建新的资源; +* [[yii\rest\UpdateAction|update]]:更新一个存在的资源; +* [[yii\rest\DeleteAction|delete]]:删除指定的资源; * [[yii\rest\OptionsAction|options]]:返回支持的HTTP方法。 -所有这些动作通过[[yii\rest\ActiveController::actions()|actions()]] 方法申明,可覆盖`actions()`方法配置或禁用这些动作, +所有这些动作通过 [[yii\rest\ActiveController::actions()|actions()]] 方法申明,可覆盖 `actions()` 方法配置或禁用这些动作, 如下所示: ```php @@ -157,9 +157,9 @@ public function prepareDataProvider() ### 执行访问检查 -通过RESTful APIs显示数据时,经常需要检查当前用户是否有权限访问和操作所请求的资源, -在[[yii\rest\ActiveController]]中, -可覆盖[[yii\rest\ActiveController::checkAccess()|checkAccess()]]方法来完成权限检查。 +通过 RESTful APIs 显示数据时,经常需要检查当前用户是否有权限访问和操作所请求的资源, +在 [[yii\rest\ActiveController]] 中, +可覆盖 [[yii\rest\ActiveController::checkAccess()|checkAccess()]] 方法来完成权限检查。 ```php /** @@ -185,7 +185,7 @@ public function checkAccess($action, $model = null, $params = []) } ``` -`checkAccess()` 方法默认会被[[yii\rest\ActiveController]]默认动作所调用,如果创建新的操作并想执行权限检查, +`checkAccess()` 方法默认会被 [[yii\rest\ActiveController]] 默认动作所调用,如果创建新的操作并想执行权限检查, 应在新的动作中明确调用该方法。 -> Tip: 可使用[Role-Based Access Control (RBAC) 基于角色权限控制组件](security-authorization.md)实现`checkAccess()`。 +> Tip: 可使用 [Role-Based Access Control (RBAC) 基于角色权限控制组件](security-authorization.md) 实现 `checkAccess()`。