答案：开发Yii2的RESTful API需配置URL美化和路由规则，启用JsonParser支持JSON数据提交，使用UrlRule生成标准REST路由；创建继承yii\rest\ActiveController的控制器并指定$modelClass，即可自动实现用户资源的增删改查操作；通过重写behaviors()和actions()方法可自定义权限控制与数据提供方式；Yii2默认返回JSON格式响应，可通过response组件设置返回数据结构，并结合异常捕获返回标准化错误信息；该机制可扩展至其他资源如产品、订单等。
开发Yii2的RESTful API并不复杂，只要理解其路由机制、控制器结构和数据格式处理方式。下面是一个实用的开发流程，帮助你快速搭建一个标准的RESTful接口服务。
配置URL美化和路由规则
为了让API地址更简洁，比如 /api/users 而不是 /index.php?r=api%2Fuser7>，需要启用URL美化（Pretty URL）并设置规则。
在 config/web.php 中配置components的request和urlManager：
'components' => [
'request' => [
'parsers' => [
'application/json' => 'yii\web\JsonParser',
]
],
'urlManager' => [
'enablePrettyUrl' => true,
'enableStrictParsing' => false,
'showScriptName' => false,
'rules' => [
['class' => 'yii\rest\UrlRule', 'controller' => 'api/user'],
],
],
],
说明：
- JsonParser 允许POST/PUT请求使用JSON格式提交数据
- UrlRule 自动为controller生成标准REST路由，如GET /api/users → index，POST /api/users → create
创建REST控制器
继承 yii\rest\ActiveController 可以快速实现资源操作。假设我们有一个User模型。
创建文件 controllers/ApiController.php 和 controllers/UserController.php
// controllers/ApiController.php
class ApiController extends \yii\rest\Controller
{
// 可以放公共逻辑或认证检查
}
// controllers/UserController.php
class UserController extends \yii\rest\ActiveController
{
public $modelClass = 'app\models\User';
}
这样就自动支持以下操作：
- GET /api/users → 列出所有用户
- GET /api/users/1 → 获取ID为1的用户
- POST /api/users → 创建新用户
- PUT /api/users/1 → 更新ID为1的用户
- DELETE /api/users/1 → 删除用户
自定义行为和权限控制
如果想修改默认行为或添加权限验证，可以重写actions()或behaviors()方法。
public function behaviors()
{
$behaviors = parent::behaviors();
// 移除不需要的认证（开发阶段）
unset($behaviors['authenticator']);
return $behaviors;
}
也可以只允许特定动作：
public function actions()
{
$actions = parent::actions();
$actions['index']['prepareDataProvider'] = [$this, 'prepareDataProvider'];
return $actions;
}
public function prepareDataProvider()
{
$model = new User();
return new \yii\data\ActiveDataProvider([
'query' => $model->find(),
'pagination' => ['pageSize' => 10],
]);
}
返回格式与错误处理
Yii2默认使用JSON格式输出。可通过response组件控制返回内容。
例如在控制器中手动返回数据：
\Yii::$app->response->format = \yii\web\Response::FORMAT_JSON; return ['status' => 'success', 'data' => $data];
捕获异常并返回标准错误：
try {
// 业务逻辑
} catch (\Exception $e) {
return ['error' => $e->getMessage()];
}
基本上就这些。按照这个结构，你可以扩展多个资源控制器，比如ProductController、OrderController等，每个都对应一套REST接口。关键是理解ActiveController的自动化机制和UrlRule的映射逻辑。调试时打开日志或用Postman测试各种请求类型，确保状态码和数据正确。
