mirror of
https://github.com/yiisoft/yii2.git
synced 2025-11-01 03:26:36 +08:00
Update rest-quick-start.md
This commit is contained in:
@ -4,16 +4,17 @@
|
|||||||
Yii 提供了一整套用来简化实现 RESTful 风格的 Web Service 服务的 API。
|
Yii 提供了一整套用来简化实现 RESTful 风格的 Web Service 服务的 API。
|
||||||
特别是,Yii 支持以下关于 RESTful 风格的 API:
|
特别是,Yii 支持以下关于 RESTful 风格的 API:
|
||||||
|
|
||||||
* 支持 [Active Record](db-active-record.md) 类的通用API的快速原型
|
* 支持 [Active Record](db-active-record.md) 类的通用 API 的快速原型;
|
||||||
* 涉及的响应格式(在默认情况下支持 JSON 和 XML)
|
* 涉及的响应格式(在默认情况下支持 JSON 和 XML);
|
||||||
* 支持可选输出字段的定制对象序列化
|
* 支持可选输出字段的定制对象序列化;
|
||||||
* 适当的格式的数据采集和验证错误
|
* 适当的格式的数据采集和验证错误;
|
||||||
* 支持 [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)
|
* 集合分页,过滤和排序;
|
||||||
* 有适当HTTP动词检查的高效的路由
|
* 支持 [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS);
|
||||||
* 内置`OPTIONS`和`HEAD`动词的支持
|
* 有适当 HTTP 动词检查的高效的路由;
|
||||||
* 认证和授权
|
* 内置 `OPTIONS` 和 `HEAD` 动词的支持;
|
||||||
* 数据缓存和HTTP缓存
|
* 认证和授权;
|
||||||
* 速率限制
|
* 数据缓存和 HTTP 缓存;
|
||||||
|
* 速率限制;
|
||||||
|
|
||||||
|
|
||||||
如下, 我们用一个例子来说明如何用最少的编码来建立一套RESTful风格的API。
|
如下, 我们用一个例子来说明如何用最少的编码来建立一套RESTful风格的API。
|
||||||
@ -187,10 +188,15 @@ Content-Type: application/json; charset=UTF-8
|
|||||||
> 例如 `password_hash`, `auth_key` 你肯定不希望这些出现在你的 API 结果中。
|
> 例如 `password_hash`, `auth_key` 你肯定不希望这些出现在你的 API 结果中。
|
||||||
> 你应该在 [响应格式](rest-response-formatting.md) 部分中过滤掉这些字段。
|
> 你应该在 [响应格式](rest-response-formatting.md) 部分中过滤掉这些字段。
|
||||||
|
|
||||||
|
Addionally, you can sort collections like `http://localhost/users?sort=email` or
|
||||||
|
`http://localhost/users?sort=-email`. Filtering collections like `http://localhost/users?filter[id]=10` or
|
||||||
|
`http://localhost/users?filter[email][like]=gmail.com` could be implemented using
|
||||||
|
data filters. See [Resources](rest-resources.md#filtering-collections) section for details.
|
||||||
|
|
||||||
|
|
||||||
## 总结 <span id="summary"></span>
|
## 总结 <span id="summary"></span>
|
||||||
|
|
||||||
使用 Yii 框架的 RESTful 风格的 API, 在控制器的动作中实现API末端,使用
|
使用 Yii 框架的 RESTful 风格的 API, 在控制器的动作中实现 API 末端,使用
|
||||||
控制器来组织末端接口为一个单一的资源类型。
|
控制器来组织末端接口为一个单一的资源类型。
|
||||||
|
|
||||||
从 [[yii\base\Model]] 类扩展的资源被表示为数据模型。
|
从 [[yii\base\Model]] 类扩展的资源被表示为数据模型。
|
||||||
@ -199,5 +205,5 @@ Content-Type: application/json; charset=UTF-8
|
|||||||
|
|
||||||
你可以使用 [[yii\rest\UrlRule]] 简化路由到你的 API 末端。
|
你可以使用 [[yii\rest\UrlRule]] 简化路由到你的 API 末端。
|
||||||
|
|
||||||
为了方便维护你的WEB前端和后端,建议你开发接口作为一个单独的应用程序,
|
为了方便维护你的 WEB 前端和后端,建议你开发接口作为一个单独的应用程序,
|
||||||
虽然这不是必须的。
|
虽然这不是必须的。
|
||||||
|
|||||||
Reference in New Issue
Block a user