Symfony2 FOSRESTBundle REST API to return PDF


Symfony2 FOSRESTBundle REST API to return PDF

我在里面制作了一个Bundle和一个REST控制器。"index"方法返回JSON格式的数组,可以:

MyBundle/Controller/Api/Rest/BaconController.php

class BaconController extends Controller implements ClassResourceInterface
{
    /**
     * @var Request $request
     * @return array
     * @Rest'View
     */
    public function cgetAction(Request $request)
    {
        $mediaType = $request->attributes->get('media_type');
        $format = $request->getFormat($mediaType);
        my_dump($format);
        return array(
             array("id" => 1, "title" => "hello",),
             array("id" => 2, "title" => "there",),
        );
    }
}

MyBundle/Resources/config/api/routing_rest.yml

my_api_rest_bacon:
    type: rest
    resource: "MyBundle:Api/Rest/Bacon"
    name_prefix: api_rest_bacon_
    prefix: /my/bacon

因此,在这一点上,JSON结果得到了完美的返回:

mysite.com/app_dev.php/api/my/bacon/bacons.json

返回我的数组。

但现在我需要让我的控制器用数据生成一个PDF。所以我希望它在我打电话时返回PDF文档:

mysite.com/app_dev.php/api/my/bacon/bacons.pdf

我发现了一些半手册:RSS视图处理程序、RSS配置、CSV问题和答案。并试图制造类似的东西:

我已将这些行添加到

Symfony/app/config/config.yml

framework:
    [...some old stuff here...]
    request:
        formats:
            pdf: 'application/pdf'
fos_rest:
    body_converter:
        enabled:              true
    format_listener:
        rules:
            # Prototype array
            -
                # URL path info
                path:                 ~
                # URL host name
                host:                 ~
                prefer_extension:     true
                fallback_format:      html
                priorities:           [html,json]
            -
                path:                 ~
                host:                 ~
                prefer_extension:     true
                fallback_format:      pdf
                priorities:           [pdf]
    view:
        # @View or @Template
        view_response_listener: force #true
        formats:
            json: true
            pdf: true
            xls: true
            html: false
        templating_formats:
            pdf: false
            xls: false
        mime_types: {'pdf': ['application/pdf']}
    routing_loader:
        default_format: html
    param_fetcher_listener: true
    body_listener: true
    allowed_methods_listener: true
services:
    my.view_handler.pdf:
        class: Lobster'MyBundle'View'PdfViewHandler
    my.view_handler:
        parent: fos_rest.view_handler.default
        calls:
            - ['registerHandler', [ 'pdf', [@my.view_handler.pdf, 'createResponse'] ] ]

MyBundle/View/PdfViewHandler.php

namespace Lobster'MyBundle'View;
use FOS'RestBundle'View'View;
use FOS'RestBundle'View'ViewHandler;
use Symfony'Component'HttpFoundation'Request;
use Symfony'Component'HttpFoundation'Response;
class PdfViewHandler
{
    public function createResponse(ViewHandler $handler, View $view, Request $request, $format)
    {
        my_dump('pdf createResponse started');
        $pdf = "some pdf";
        return new Response($pdf, 200, $view->getHeaders());
    }
}

所以现在当我打电话给

mysite.com/app_dev.php/api/my/bacon/bacons.pdf

我看到一个错误An Exception was thrown while handling: Format html not supported, handler must be implemented,我的函数my_dump将有关文件格式的信息保存到一个文本文件中:它是html,而不是pdf

pdf createResponse也不起作用。为什么?

所以我找到了解决方案(我将描述如何启用两种输出格式:PDF和XLS):

1) config.yml中不需要此部分:

framework:
    [...some old stuff here...]
    request:
        formats:
            pdf: 'application/pdf'

2) config.yml中的fos_rest.format_listener部分应该如下所示:

format_listener:
    rules:
        -
            path:                 '^/api/my/bacon.*'.xls$'
            host:                 ~
            prefer_extension:     false
            fallback_format:      json
            priorities:           [xls, json]
        -
            path:                 '^/api/my/bacon.*'.pdf$'
            host:                 ~
            prefer_extension:     false
            fallback_format:      json
            priorities:           [pdf, json]
        -
            path:                 ~
            host:                 ~
            prefer_extension:     true
            fallback_format:      html
            priorities:           [html,json]

3) 需要在config.ymlfos_rest中添加service

fos_rest:
[...]
    service:
        view_handler: my.view_handler

4) config.yml中的services根节应该看起来像

services:
    my.view_handler.xls:
        class: Lobster'MyBundle'View'XlsViewHandler
    my.view_handler.pdf:
        class: Lobster'MyBundle'View'PdfViewHandler
    my.view_handler:
        parent: fos_rest.view_handler.default
        calls:
            - ['registerHandler', ['xls', [@my.view_handler.xls, 'createResponse'] ] ]
            - ['registerHandler', ['pdf', [@my.view_handler.pdf, 'createResponse'] ] ]

就是这样。现在它可以完美地进行

如果文件将有不同的数据内容,那么Controller也可以自己生成文件,并在BinaryFileResponse中返回结果。

  • 无需更改任何配置
  • _format可用于选择所需的文件格式
  • 所有代码都位于控制器内(以及一些与特定格式生成相关的服务),所以添加新内容或更改现有内容需要在少量文件中进行更改