Commit a10ad973 by Klimov Paul

Merge branch 'master' of github.com:yiisoft/yii2

parents 6fbd710d 8d29bcca
...@@ -62,7 +62,7 @@ Yii 2.0 权威指南 ...@@ -62,7 +62,7 @@ Yii 2.0 权威指南
* **已定稿** [行为(Behavior)](concept-behaviors.md) * **已定稿** [行为(Behavior)](concept-behaviors.md)
* **已定稿** [配置(Configurations)](concept-configurations.md) * **已定稿** [配置(Configurations)](concept-configurations.md)
* **已定稿** [类自动加载(Autoloading)](concept-autoloading.md) * **已定稿** [类自动加载(Autoloading)](concept-autoloading.md)
* **已定稿** [别名(Alias)](concept-alias.md) * **已定稿** [别名(Alias)](concept-aliases.md)
* **已定稿** [服务定位器(Service Locator)](concept-service-locator.md) * **已定稿** [服务定位器(Service Locator)](concept-service-locator.md)
* **已定稿** [依赖注入容器(DI Container)](concept-di-container.md) * **已定稿** [依赖注入容器(DI Container)](concept-di-container.md)
......
快速入门 快速入门
=========== ===========
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); * 支持 [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)
* 有适当HTTP动词检查的高效的路由; * 有适当HTTP动词检查的高效的路由
* 内置`OPTIONS``HEAD`动词的支持; * 内置`OPTIONS``HEAD`动词的支持
* 认证和授权; * 认证和授权
* 数据缓存和HTTP缓存; * 数据缓存和HTTP缓存
* 速率限制; * 速率限制
如下, 我们用一个例子来说明如何用最少的编码来建立一套RESTful风格的API。 如下, 我们用一个例子来说明如何用最少的编码来建立一套RESTful风格的API。
假设你想通过RESTful风格的API来展示用户数据。用户数据被存储在用户DB表, 假设你想通过 RESTful 风格的 API 来展示用户数据。用户数据被存储在用户DB表,
你已经创建了 [[yii\db\ActiveRecord|ActiveRecord]] 类 `app\models\User` 来访问该用户数据. 你已经创建了 [[yii\db\ActiveRecord|ActiveRecord]] 类 `app\models\User` 来访问该用户数据.
...@@ -56,26 +56,26 @@ class UserController extends ActiveController ...@@ -56,26 +56,26 @@ class UserController extends ActiveController
] ]
``` ```
上面的配置主要是为`user`控制器增加一个URL规则。这样, 上面的配置主要是为`user`控制器增加一个 URL 规则。这样,
用户的数据就能通过美化的URL和有意义的http动词进行访问和操作。 用户的数据就能通过美化的 URL 和有意义的 http 动词进行访问和操作。
## 尝试 <a name="trying-it-out"></a> ## 尝试 <a name="trying-it-out"></a>
随着以上所做的最小的努力,你已经完成了创建用于访问用户数据 随着以上所做的最小的努力,你已经完成了创建用于访问用户数据
RESTful风格的API。您所创建的API包括: RESTful 风格的 API。你所创建的 API 包括:
* `GET /users`: 逐页列出所有用户 * `GET /users`: 逐页列出所有用户
* `HEAD /users`: 显示用户列表的概要信息 * `HEAD /users`: 显示用户列表的概要信息
* `POST /users`: 创建一个新用户 * `POST /users`: 创建一个新用户
* `GET /users/123`: 返回用户为123的详细信息; * `GET /users/123`: 返回用户 123 的详细信息
* `HEAD /users/123`: 显示用户 123 的概述信息; * `HEAD /users/123`: 显示用户 123 的概述信息
* `PATCH /users/123` and `PUT /users/123`: 更新用户123; * `PATCH /users/123` and `PUT /users/123`: 更新用户123
* `DELETE /users/123`: 删除用户123; * `DELETE /users/123`: 删除用户123
* `OPTIONS /users`: 显示关于末端 `/users` 支持的动词; * `OPTIONS /users`: 显示关于末端 `/users` 支持的动词
* `OPTIONS /users/123`: 显示有关末端 `/users/123` 支持的动词 * `OPTIONS /users/123`: 显示有关末端 `/users/123` 支持的动词
> Info: Yii将在末端使用的控制器的名称自动变为复数。 > 补充:Yii 将在末端使用的控制器的名称自动变为复数。(译注:个人感觉这里应该变为注意)
你可以访问你的API用`curl`命令如下, 你可以访问你的API用`curl`命令如下,
...@@ -109,7 +109,7 @@ Content-Type: application/json; charset=UTF-8 ...@@ -109,7 +109,7 @@ Content-Type: application/json; charset=UTF-8
] ]
``` ```
试着改变可接受的内容类型为`application/xml`,你会看到结果以XML格式返回: 试着改变可接受的内容类型为`application/xml`,你会看到结果以 XML 格式返回:
``` ```
$ curl -i -H "Accept:application/xml" "http://localhost/users" $ curl -i -H "Accept:application/xml" "http://localhost/users"
...@@ -142,33 +142,32 @@ Content-Type: application/xml ...@@ -142,33 +142,32 @@ Content-Type: application/xml
</response> </response>
``` ```
> Tip: 您还可以通过Web浏览器中输入URL `http://localhost/users` 来访问你的API。 > 技巧:你还可以通过 Web 浏览器中输入 URL `http://localhost/users` 来访问你的 API。
尽管如此,你可能需要一些浏览器插件来发送特定的headers请求。 尽管如此,你可能需要一些浏览器插件来发送特定的 headers 请求。
如你所见, 在headers响应, 有关于总数,页数的信息,等等。 如你所见,在 headers 响应,有关于总数,页数的信息,等等。
还有一些链接,让您导航到其他页面的数据. 例如, `http://localhost/users?page=2` 还有一些链接,让你导航到其他页面的数据。例如: `http://localhost/users?page=2`
会给你的用户数据的下一个页面。 会给你的用户数据的下一个页面。
使用 `fields``expand` 参数,也可以指定哪些字段应该包含在结果内。 使用 `fields``expand` 参数,也可以指定哪些字段应该包含在结果内。
例如, URL `http://localhost/users?fields=id,email` 将只返回 `id``email` 字段。 例如URL `http://localhost/users?fields=id,email` 将只返回 `id``email` 字段。
> Info: 您可能已经注意到了 `http://localhost/users` 的结果包括一些敏感字段, > 补充:你可能已经注意到了 `http://localhost/users` 的结果包括一些敏感字段,
> 例如 `password_hash`, `auth_key`。 你肯定不希望这些出现在你的API结果中。 > 例如 `password_hash`, `auth_key` 你肯定不希望这些出现在你的 API 结果中。
> 你应该在 [Response Formatting](rest-response-formatting.md) 部分中过滤掉这些字段。 > 你应该在 [响应格式](rest-response-formatting.md) 部分中过滤掉这些字段。
## 总结 <a name="summary"></a> ## 总结 <a name="summary"></a>
使用Yii框架的RESTful风格的API, 在控制器的操作中实现API末端, 使用 使用 Yii 框架的 RESTful 风格的 API, 在控制器的操作中实现API末端,使用
控制器来组织末端接口为一个单一的资源类型。 控制器来组织末端接口为一个单一的资源类型。
[[yii\base\Model]] 类扩展的资源被表示为数据模型。 [[yii\base\Model]] 类扩展的资源被表示为数据模型。
如果你在使用(关系或非关系)数据库,推荐使用 [[yii\db\ActiveRecord|ActiveRecord]] 如果你在使用(关系或非关系)数据库,推荐使用 [[yii\db\ActiveRecord|ActiveRecord]]
来表示资源。 来表示资源。
你可以使用 [[yii\rest\UrlRule]] 简化路由到你的API末端。 你可以使用 [[yii\rest\UrlRule]] 简化路由到你的 API 末端。
虽然不是必须的,为了方便维护您的WEB前端和后端, 为了方便维护你的WEB前端和后端,建议你开发接口作为一个单独的应用程序,虽然这不是必须的。
建议您开发接口作为一个单独的应用程序。
...@@ -246,7 +246,7 @@ return [ ...@@ -246,7 +246,7 @@ return [
### 资源部署 <a name="asset-mapping"></a> ### 资源部署 <a name="asset-mapping"></a>
有时你想"修复" 多个资源包中资源文件的错误/不兼容,例如包A使用1.11.1版本的`jquery.min.js` 有时你想"修复" 多个资源包中资源文件的错误/不兼容,例如包A使用1.11.1版本的`jquery.min.js`
包B使用2.1.1版本的`jquery.js`,可自定义每个包来解决这个问题,更好的方式是使用*资源部署*特性来不熟不正确的资源为想要的, 包B使用2.1.1版本的`jquery.js`,可自定义每个包来解决这个问题,更好的方式是使用*资源部署*特性来部署不正确的资源为想要的,
为此,配置[[yii\web\AssetManager::assetMap]]属性,如下所示: 为此,配置[[yii\web\AssetManager::assetMap]]属性,如下所示:
```php ```php
...@@ -347,7 +347,7 @@ Yii使用文件扩展名来表示资源使用哪种扩展语法,默认可以 ...@@ -347,7 +347,7 @@ Yii使用文件扩展名来表示资源使用哪种扩展语法,默认可以
- [CoffeeScript](http://coffeescript.org/): `.coffee` - [CoffeeScript](http://coffeescript.org/): `.coffee`
- [TypeScript](http://www.typescriptlang.org/): `.ts` - [TypeScript](http://www.typescriptlang.org/): `.ts`
Yii依靠安装的预处理公斤来转换资源,例如,为使用[LESS](http://lesscss.org/),应安装`lessc` 预处理命令。 Yii依靠安装的预处理工具来转换资源,例如,为使用[LESS](http://lesscss.org/),应安装`lessc` 预处理命令。
可配置[[yii\web\AssetManager::converter]]自定义预处理命令和支持的扩展语法,如下所示: 可配置[[yii\web\AssetManager::converter]]自定义预处理命令和支持的扩展语法,如下所示:
......
...@@ -276,7 +276,6 @@ public function rules() ...@@ -276,7 +276,6 @@ public function rules()
## 块赋值 <a name="massive-assignment"></a> ## 块赋值 <a name="massive-assignment"></a>
## Massive Assignment <a name="massive-assignment"></a>
块赋值只用一行代码将用户所有输入填充到一个模型,非常方便, 块赋值只用一行代码将用户所有输入填充到一个模型,非常方便,
它直接将输入数据对应填充到 [[yii\base\Model::attributes]] 属性。 它直接将输入数据对应填充到 [[yii\base\Model::attributes]] 属性。
......
...@@ -30,7 +30,7 @@ forum/ ...@@ -30,7 +30,7 @@ forum/
### 模块类 <a name="module-classes"></a> ### 模块类 <a name="module-classes"></a>
每个模块都有一个继承[[yii\base\Module]]的模块类,该类文件直接放在模块的[[yii\base\Module::basePath|base path]]目录下, 每个模块都有一个继承[[yii\base\Module]]的模块类,该类文件直接放在模块的[[yii\base\Module::basePath|base path]]目录下,
并且能被 [自动加载](concept-autoloading.md)。当一个模块被访问,和 [application instances](structure-applications.md) 并且能被 [自动加载](concept-autoloading.md)。当一个模块被访问,和 [应用主体实例](structure-applications.md)
类似会创建该模块类唯一实例,模块实例用来帮模块内代码共享数据和组件。 类似会创建该模块类唯一实例,模块实例用来帮模块内代码共享数据和组件。
以下示例一个模块类大致定义: 以下示例一个模块类大致定义:
......
...@@ -12,7 +12,6 @@ China ...@@ -12,7 +12,6 @@ China
- **Paris Qian Sen 东方孤思子,[@qiansen1386](https://github.com/qiansen1386),qiansen1386@gmail.com** - **Paris Qian Sen 东方孤思子,[@qiansen1386](https://github.com/qiansen1386),qiansen1386@gmail.com**
- [@AbrahamGreyson 刘阳](https://github.com/AbrahamGreyson) - [@AbrahamGreyson 刘阳](https://github.com/AbrahamGreyson)
- [@Aliciamiao](https://github.com/aliciamiao)
- [@fmalee](https://github.com/fmalee) - [@fmalee](https://github.com/fmalee)
- [@funson86 花生](https://github.com/funson86) - [@funson86 花生](https://github.com/funson86)
- [@ivantree 长兴苗木](https://github.com/ivantree) - [@ivantree 长兴苗木](https://github.com/ivantree)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment