Symfony2 + FOSRestBundle:为每个控制器/操作启用/禁用REST功能?

时间:2012-08-09 13:04:21

标签: rest symfony fosuserbundle fosrestbundle

我的应用程序的一部分将作为 API 提供,因此我的某些页面需要以JSON或XML提供(基于Accept标头'内容类型')。

我使用了 FOSRestBundle 并且效果非常好,但现在 ALL 在发送Accept标头'内容类型时,我的网页可用XML(或JSON)提供:应用/ XML”。

所以,我想为我的一些控制器/操作启用/禁用此功能。使用注释我会很理想。

这可能吗?

我的config.yml:

fos_rest:
    view:
        formats:
            rss: false
            xml: true 
            json: true
        templating_formats:
            html: true
        force_redirects:
            html: false
        failed_validation: HTTP_BAD_REQUEST
        default_engine: twig
        view_response_listener: force
    body_listener:
        decoders:
            json: acme.decoder.json
            xml: fos_rest.decoder.xml
    format_listener:
        default_priorities: ['html', 'xml', 'json', '*/*']
        fallback_format: html
        prefer_extension: false    

2 个答案:

答案 0 :(得分:6)

根据the RestBundle's documentation,如果您未在控制器中使用View,则无法获得XML输出。因此,如果您未在操作中使用@View注释或View::create(),并且返回经典响应,则会获得HTML输出。

如果您出于某些原因要强制使用该格式,可以将prefer_extension转为true并调整路由定义:

my_route:
    pattern:  /my-route
    defaults: { _controller: AcmeDemoBundle:action, _format: <format> }

<format>是您要强制使用的格式。

答案 1 :(得分:2)

您可以将view_response_listener设置为false(默认为force)。然后将@View注释添加到您要使用REST的每个控制器类中。

示例将使其更清晰。

没有REST的控制器:

/**
 * @Route("/comments")
 */
class CommentsControler extends Controller
{
    /**
     * @Route("/")
     * @Method({"POST"})
     */
    public function newAction() { ... }

    /**
     * @Route("/{id}")
     */
    public function detailAction($id) { ... }

    ...
}

另一个带REST的控制器。请注意,只需要@View该类的注释(除非您要覆盖响应状态代码)。

/**
 * @View
 * @Route("/api/comments")
 */
class RestfulCommentsControler extends Controller
{
    /**
     * @Route("/")
     * @Method({"POST"})
     */
    public function newAction() { ... }

    /**
     * @Route("/{id}")
     */
    public function detailAction($id) { ... }

    /**
     * @View(statusCode=204)
     * @Route("/{id}/delete")
     */
    public function deleteAction($id) { ... }

    ...
}
  • ViewFOS\RestBundle\Controller\Annotations\View
  • RouteSymfony\Component\Routing\Annotation\Route