©
本文档使用
php.cn手册 发布
Yii 提供了一整套用来简化实现 RESTful 风格的 Web Service 服务的 API。 特别是,Yii 支持以下关于 RESTful 风格的 API:
OPTIONS
和HEAD
动词的支持如下, 我们用一个例子来说明如何用最少的编码来建立一套RESTful风格的API。
假设你想通过 RESTful 风格的 API 来展示用户数据。用户数据被存储在用户DB表, 你已经创建了 yii\db\ActiveRecord 类app\models\User
来访问该用户数据.
首先,创建一个控制器类 app\controllers\UserController
如下,
1 2 3 4 5 6 7 8 |
|
控制器类扩展自 yii\rest\ActiveController。通过指定 yii\rest\ActiveController::modelClass 作为 app\models\User
, 控制器就能知道使用哪个模型去获取和处理数据。
然后,修改有关在应用程序配置的urlManager
组件的配置:
1 2 3 4 5 6 7 8 9 |
|
上面的配置主要是为user
控制器增加一个 URL 规则。这样, 用户的数据就能通过美化的 URL 和有意义的 http 动词进行访问和操作。
随着以上所做的最小的努力,你已经完成了创建用于访问用户数据 的 RESTful 风格的 API。你所创建的 API 包括:
GET /users
: 逐页列出所有用户HEAD /users
: 显示用户列表的概要信息POST /users
: 创建一个新用户GET /users/123
: 返回用户 123 的详细信息HEAD /users/123
: 显示用户 123 的概述信息PATCH /users/123
and PUT /users/123
: 更新用户123DELETE /users/123
: 删除用户123OPTIONS /users
: 显示关于末端 /users
支持的动词OPTIONS /users/123
: 显示有关末端 /users/123
支持的动词补充:Yii 将在末端使用的控制器的名称自动变为复数。(译注:个人感觉这里应该变为注意)
你可以访问你的API用curl
命令如下,
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 |
|
试着改变可接受的内容类型为application/xml
,你会看到结果以 XML 格式返回:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 |
|
技巧:你还可以通过 Web 浏览器中输入 URL
http://localhost/users
来访问你的 API。 尽管如此,你可能需要一些浏览器插件来发送特定的 headers 请求。
如你所见,在 headers 响应,有关于总数,页数的信息,等等。 还有一些链接,让你导航到其他页面的数据。例如:http://localhost/users?page=2
会给你的用户数据的下一个页面。
使用 fields
和 expand
参数,你也可以指定哪些字段应该包含在结果内。 例如:URL http://localhost/users?fields=id,email
将只返回 id
和 email
字段。
补充:你可能已经注意到了
http://localhost/users
的结果包括一些敏感字段, 例如password_hash
,auth_key
你肯定不希望这些出现在你的 API 结果中。 你应该在 响应格式 部分中过滤掉这些字段。
使用 Yii 框架的 RESTful 风格的 API, 在控制器的操作中实现API末端,使用 控制器来组织末端接口为一个单一的资源类型。
从 yii\base\Model 类扩展的资源被表示为数据模型。 如果你在使用(关系或非关系)数据库,推荐你使用 yii\db\ActiveRecord 来表示资源。
你可以使用 yii\rest\UrlRule 简化路由到你的 API 末端。