快速入门
Yii 提供了一整套用来简化实现 RESTful 风格的 Web Service 服务的 API。 特别是,Yii 支持以下关于 RESTful 风格的 API:
- 支持 Active Record 类的通用API的快速原型
- 涉及的响应格式(在默认情况下支持 JSON 和 XML)
- 支持可选输出字段的定制对象序列化
- 适当的格式的数据采集和验证错误
- 支持 HATEOAS
- 有适当HTTP动词检查的高效的路由
- 内置
OPTIONS
和HEAD
动词的支持 - 认证和授权
- 数据缓存和HTTP缓存
- 速率限制
如下, 我们用一个例子来说明如何用最少的编码来建立一套RESTful风格的API。
假设你想通过 RESTful 风格的 API 来展示用户数据。用户数据被存储在用户DB表, 你已经创建了 yii\db\ActiveRecord 类 app\models\User
来访问该用户数据.
创建一个控制器
首先,创建一个控制器类 app\controllers\UserController
如下,
namespace app\controllers;
use yii\rest\ActiveController;
class UserController extends ActiveController
{