使用 FOSRestBundle 修改静止响应的对象输出

Question

我在使用 FOSRestBundle 实现本应简单的事情时遇到了麻烦。

如果我返回一个对象，它会按预期工作。 JSON 响应将类似于

{ 
  id: ..., 
  property: ... 
}

我想做的是在所有请求和状态代码上返回一个用于响应的信封，例如

{
  meta: {
    code: 200,
    message: 'OK',
  }
  data: {
    id: ...,
    property: ...
  }
}

这样，客户可以编写简单的代码来检测错误，其中的响应类似于：

{
  meta: {
    code: 400,
    message: 'Your request failed because...',
  }
  data: {}
}

我想从多个控制器返回它，并且只在 JSON 或 XML 请求上返回它。我的第一个想法是使用 ResponseListener，检查请求的格式，并在需要时修改响应。或者，也许，只是设置一个类似的类 \Model\APIRequestFormatter，并从我的控制器，而不是做 return $entity; 做 return APIRequestFormatter->Format($entity);

这两种方法对我来说似乎都有缺陷，有人有什么建议吗？

Answer 1

您应该看看这篇非常完整的博文： http://williamdurand.fr/2012/08/02/rest-apis-with-symfony2-the-right-way/

William Durand 谈到了如何创建良好的 REST Api 以及带有正确状态代码的 JSON 响应。

如果您遵循 William 在他的文章中所写的内容，您将收到基于此格式的 JSON 响应：

{
    code: 400,
    message: "Your message",
    first_data: "...",
    second_data: "...",
    ...
}

这不是您正在寻找的。但我认为您的客户必须编写的代码将与您建议的格式一样简单：

{
  meta: {
    code: 400,
    message: 'Your request failed because...',
  }
  data: {}
}

也许您可以显示您在控制器中所做的事情，以便我的回答更准确。

---

更新：

使用以下控制器，您应该能够返回所需的 JSON 响应：

use Symfony\Component\HttpFoundation\JsonResponse;

class MyController{
    //...
    public function myAction(){
        $myStatusCode = 400;

        return new JSonResponse(
            array('meta' => array('code' => $myStatusCode,
                                  'message' => 'Your request failed because...'),
                  'data' => array('your datas')
            ),
            $myStatusCode
        );
    }
    //...
}

这将在标头中创建带有正确状态代码的响应，并允许您在 JSon 响应中添加所需的消息和状态代码。