Yii 2 framework 提供了一套 REST API ，通过简单配置即可对外提供服务，支持 JSON、XML 多种格式选择输出；支持 HTTP Basic auth、OAuth 2 等认证方式，用起来确实很爽。

在定义 API 的时候，最常见的就是自定义返回格式，我找到 4 种方式，纪录如下：

第一种：来自官方文档，通过修改 config 文件

return [
    // ...
    'components' => [
        'response' => [
            'class' => 'yii\web\Response',
            'on beforeSend' => function ($event) {
                $response = $event->sender;
                if ($response->data !== null && Yii::$app->request->get('suppress_response_code')) {
                    $response->data = [
                        'success' => $response->isSuccessful,
                        'data' => $response->data,
                    ];
                    $response->statusCode = 200;
                }
            },
        ],
    ],
];

第二种：使用 controller 中的 afterAction 方法，在响应完 action 之后，对数据格式化

use Yii;
class MobileController extends yii\rest\Controller
{
    public function afterAction($action, $result)
    {
        $rs = parent::afterAction($action, $result);
        // 也可以再定义 response
        // $response = Yii::$app->response;
        // $response->statusCode = 200;
        // $response->data = ['message' => 'hello world'];
        return ['data' => $rs, 'error' => '0'];
    }
}

第三种：自定义 Error handler ，来自 github

public function init()
{
    parent::init();

    $handler = new \app\components\ApiErrorHandler;
    \Yii::$app->set('errorHandler', $handler);
    $handler->register();
}

第四种：与第一种类似，在 controller 中绑定 response 的 beforeSend 事件，不同是它不是 global ，更灵活

public function init()
{
    parent::init();

    Event::on(Response::className(), Response::EVENT_BEFORE_SEND, [$this, 'formatDataBeforeSend']);
}

public function formatDataBeforeSend($event)
{
    $response = $event->sender;
    // do something
}

That’s all.
Fin.