覆盖FOS Rest Bundle响应

Question

我正在为我的RESTful API使用FOS Rest捆绑包，我想覆盖从我的ApiController返回的响应，例如：

PHP

/**
 * @QueryParam(name="sourceAddr", strict=true, requirements="[0-9]{8}", description="Do things")
 * @param $paramFetcher ParamFetcher
 * @return array
 * @throws MtBoxApiException
 */
public function getAuthAction(ParamFetcher $paramFetcher)
{
    return [
        'rfid' => '445545454',
        'fName' => 'adazda',
        'lName' => '8888888',
        'prod' => 75
    ];
}

我想要的是向返回的响应添加额外的数据，因此我想要截获这些响应并根据某些条件覆盖它们。

我想要api返回的最终结果：

{
   someAdditionalData1: value1,
   someAdditionalData2: value2,
   data: {
     //the data returned by the controller action
   }
}

Answer 1

要了解如何做到这一点，可以查看FOS\RestBundle\EventListener\ViewResponseListener类。它们将此类注册为事件订阅者。您可以在服务中以相同的方式注册类。yml

test_response_listener:
    class: MyBundle\EventListener\MyViewResponseListener
    tags:
        - { name: kernel.event_subscriber }

您需要确保类实现Symfony\Component\EventDispatcher\EventSubscriberInterface，并包含如下方法getSubscribedEvents：

public static function getSubscribedEvents()
{
    return array(
        KernelEvents::VIEW => array('onKernelView', 50),
    );
}

事件为“onKernelView”，即返回视图时。仅当来自控制器的响应实际上不是响应对象时，才会调用此函数。在我的测试中，我返回了一个用户对象，因此调用了它。“50”代表优先权。如果您没有将其设置为高于30，那么将首先调用FOSRestBundle侦听器并设置响应。如果这些侦听器中的任何一个调用$event-

onKernelView是要调用的方法的名称。它将接收特定类型的事件，因此让您的方法签名如下所示：

public function onKernelView(GetResponseForControllerResultEvent $event)

现在，最后，您要做的是统一响应格式。您可以通过更改监听器方法中事件的控制器结果来实现这一点，以匹配所需的格式：

$event->setControllerResult([
    'foo' => 'bar',
    'data' => $event->getControllerResult()
]);

如果已设置序列化程序，它仍应按正常方式序列化控制器结果，但您将在响应中获得添加的数据。