RESTful 响应如何在 Yii2 中返回 JSON 而不是 XML？

Posted 2023-03-15

【中文标题】RESTful 响应如何在 Yii2 中返回 JSON 而不是 XML？

【英文标题】：RESTful response how to return JSON instead of XML in Yii2?

【发布时间】：2016-02-11 22:05:31

【问题描述】：

问题是来自 Yii2 中 RESTful 服务器的响应以 XML 形式返回，我需要它们为 JSON 格式。

我按照 Yii2 的指南，控制器看起来一样，模型有点不同，它连接到数据库（模型之前是从高级模板中的默认模型复制的），并且 web 配置是也和指南一样。

只是为了澄清任何疑问，这里是代码：

用户控制器.php

<?php
namespace app\controllers;

use yii\rest\ActiveController;

class UserController extends ActiveController

    public $modelClass = 'app\models\User';

web.php ($config)

$config = [
    'id' => 'basic',
    'basePath' => dirname(__DIR__),
    'bootstrap' => ['log'],
    'components' => [
        'request' => [
            // !!! insert a secret key in the following (if it is empty) - this is required by cookie validation
            'cookieValidationKey' => 'WgkzlqvStTfGXY-ToFlQIJRDMX4LUQtY',
            'parsers'=>[
                'application/json'=>'yii\web\JsonParser'
            ]
        ],
        'cache' => [
            'class' => 'yii\caching\FileCache',
        ],
        'user' => [
            'identityClass' => 'app\models\User',
            'enableAutoLogin' => true,
        ],
        'urlManager' => [
            'enablePrettyUrl' => true,
            'enableStrictParsing' => true,
            'showScriptName' => false,
            'rules' => [
                ['class' => 'yii\rest\UrlRule', 'controller' => 'user'],
            ],
        ],
        'errorHandler' => [
            'errorAction' => 'site/error',
        ],
        'mailer' => [
            'class' => 'yii\swiftmailer\Mailer',
            // send all mails to a file by default. You have to set
            // 'useFileTransport' to false and configure a transport
            // for the mailer to send real emails.
            'useFileTransport' => true,
        ],
        'log' => [
            'traceLevel' => YII_DEBUG ? 3 : 0,
            'targets' => [
                [
                    'class' => 'yii\log\FileTarget',
                    'levels' => ['error', 'warning'],
                ],
            ],
        ],
        'db' => require(__DIR__ . '/db.php'),
    ],
    'params' => $params,
];

我尝试了配置组件中的设置：

response=>[
    'format'=>yii\web\Response::FORMAT_JSON
]

...但它仍然以 XML 响应。我该怎么做才能让它响应 JSON？

【参考方案1】：

您可以在通话时设置它，如下所示：

\Yii::$app->response->format = \yii\web\Response::FORMAT_JSON;

例如：

public function actionView($id) \
  Yii::$app - > response - > format = \yii\ web\ Response::FORMAT_JSON;
  $user = \app\ models\ User::find($id);
  return $user;

您还可以在您的类行为中使用ContentNegotiator 过滤器，如下所示：

/**
 * @inheritdoc
 */
public function behaviors() 
  return [
    [
      'class' => \yii\ filters\ ContentNegotiator::className(),
      'only' => ['index', 'view'],
      'formats' => [
        'application/json' => \yii\ web\ Response::FORMAT_JSON,
      ],
    ],
  ];

【讨论】：

但是有没有办法全局设置呢？而不是在每个控制器中添加这个？

@nosthertus 看看***.com/questions/27180059/…

我通过控制器尝试了您的方法并且它有效，但是我尝试了您引用的帖子显示的内容并且它不起作用，它仍然会以 xml 响应，您可以在此处查看代码：pastebin.com/PawqVx7X

【参考方案2】：

只需在应用程序配置中设置响应格式：

'components' => [
    ... // config
    'response' => [
        'format' => \yii\web\Response::FORMAT_JSON
    ],
    ... // config
]

【参考方案3】：

另一种方法是派生自定义响应类并根据数据类型设置格式。

class Response extends \yii\web\Response

    protected function prepare()
    
        if (is_object($this->data) || is_array($this->data)) 
            $this->format = self::FORMAT_JSON;
        
        return parent::prepare();
    

然后在配置文件中注册这个类型。

'response' => [
    'class' => 'app\components\Response',
]