我已将 FOSRestBundle 配置如下:

#FOSRestBundle
fos_rest:
    param_fetcher_listener: true
    body_listener: true
    format_listener:
        rules:
            - { path: ^/, priorities: [ json, html ], fallback_format: ~, prefer_extension: true }
        media_type:
            version_regex: '/(v|version)=(?P<version>[0-9\.]+)/'

    body_converter:
        enabled: true
        validate: true

    view:
        mime_types:
            json: ['application/json', 'application/json;version=1.0', 'application/json;version=1.1']
        view_response_listener: 'force'
        formats:
            xml:  false
            json: true
        templating_formats:
            html: true

    exception:
        codes:
            'Symfony\Component\Routing\Exception\ResourceNotFoundException': 404
            'Doctrine\ORM\OptimisticLockException': HTTP_CONFLICT
        messages:
            'Symfony\Component\Routing\Exception\ResourceNotFoundException': true
    allowed_methods_listener: true
    access_denied_listener:
        json: true

我在 Controller 上有这个:

namespace PDI\PDOneBundle\Controller\Rest;

use FOS\RestBundle\Controller\FOSRestController;
use Nelmio\ApiDocBundle\Annotation\ApiDoc;
use FOS\RestBundle\Controller\Annotations\QueryParam;
use FOS\RestBundle\Controller\Annotations\Get;

class RepresentativeRestController extends FOSRestController
{
    /**
     * Get all representatives.
     *
     * @return array
     *
     * @ApiDoc(
     *   resource = true,
     *       https = true,
     *   description = "Get all representatives.",
     *   statusCodes = {
     *      200 = "Returned when successful",
     *      400 = "Returned when errors"
     *   }
     * )
     * @Get("/api/v1/reps")
     */
    public function getRepsAction()
    {
        $em = $this->getDoctrine()->getManager();
        $entities = $em->getRepository('PDOneBundle:Representative')->findAll();

        if(!$entities)
        {
            return $this->view(null, 400);
        }

        return $this->view($entities, 200);
    }
}

但是当我尝试以下 URL app_dev.php/api/v1/reps 时，我收到了这个错误:

Unable to find template "". 500 Internal Server Error - InvalidArgumentException 3 linked Exceptions: Twig_Error_Loader » InvalidArgumentException » InvalidArgumentException »

我希望 API 返回格式正确的 JSON，如下例所示:

{
   "id":"30000001",
   "veeva_rep_id":"0055648764067SwzAAE",
   "display_name":"John Know",
   "avatar_url":"http://freelanceme.net/Images/default%20profile%20picture.png",
   "rep_type":"VEEVA",
   "username":"john@mail.com",
   "first":"John",
   "last":"Know",
   "title":"Sales Representative",
   "phone":"800-555-1212",
   "email":"john@mail.com",
   "territory_id":"200454001",
   "inactive":"no",
   "total_contacts":"6",
   "total_shares":"0",
   "totalViews":"0",
   "lastLoginAt":"2015-05-05 15:45:57",
   "lastVeevaSyncAt":"2015-05-05 15:45:57",
   "createdAt":"2015-05-05 15:45:57",
   "updatedAt":"2015-05-05 15:45:57"
}

FOSRestBundle 没有配置返回 JSON 吗？为什么还要求 Twig 模板？我该如何解决这个问题？

第一次测试:

正如@Jeet 建议我尝试使用 Postman(与他告诉我的扩展相同)并在将 header Content-Type 设置为 application/json 之后错误变成了这个

Malformed JSON

因此，FOSRestBundle 没有按应有的方式设置 header ， Controller 也没有返回有效的 JSON，我该如何解决这些问题？

第二次测试:

按照@Jeet的建议，我运行了这个测试:

/**
 * Get all representatives.
 *
 * @return array
 *
 * @ApiDoc(
 *   resource = true,
 *       https = true,
 *   description = "Get all representatives.",
 *   statusCodes = {
 *      200 = "Returned when successful",
 *      400 = "Returned when errors"
 *   }
 * )
 * @Get("/api/v1/reps")
 * @View()
 */
public function getRepsAction()
{
    $em = $this->getDoctrine()->getManager();
    $entities = $em->getRepository('PDOneBundle:Representative')->findAll();

    $temp = array("1", "2", "3");

    $view = $this->view($temp, Codes::HTTP_OK);
    return $this->handleView($view);
}

还是一样的问题:

Unable to find template "". 500 Internal Server Error - InvalidArgumentException 3 linked Exceptions: Twig_Error_Loader » InvalidArgumentException » InvalidArgumentException »

这里还有什么问题？我在配置时遗漏了什么吗？

我一开始忘记添加 app/config/routing.yml 和 src/PDI/PDOneBundle/Resources/config/routing.yml 所以他们来了，也许这是拼图中缺失的部分，让您更好地了解问题的来源:

#app/config/routing.yml
#PDOne
pdone:
    resource: "@PDOneBundle/Resources/config/routing.yml"

template:
    resource: "@TemplateBundle/Resources/config/routing.yml"

#FOSUserBundle
fos_user:
    resource: "@FOSUserBundle/Resources/config/routing/all.xml"
    prefix: /

#NelmioApiDocBundle:
NelmioApiDocBundle:
    resource: "@NelmioApiDocBundle/Resources/config/routing.yml"
    prefix:   /api/doc

#SonataAdmin
admin:
    resource: '@SonataAdminBundle/Resources/config/routing/sonata_admin.xml'
    prefix: /admin

_sonata_admin:
    resource: .
    type: sonata_admin
    prefix: /admin

#src/PDI/PDOneBundle/Resources/config/routing.yml
pdone:
    resource: "@PDOneBundle/Controller/"
    type:     annotation
    prefix:   /

第三个测试:

如果我使用 Postman 之类的工具并设置正确的 header ，客户端的请求肯定有问题，我得到了我想要的实体，请参见下图:

我找不到问题出在哪里，所以我在这里迫切需要别人的帮助，因为我已经没有主意了

最佳答案

正如大家所建议的:只有 Accept header 或扩展才能为您提供 JSON。似乎您已使用 Accept header 对此进行了排序。

为了使用扩展，你必须告诉你想如何在 Symfony 中设置格式。

这段代码应该给你一个你想要的输出:

namespace RestTestBundle\Controller;

use FOS\RestBundle\Controller\Annotations\View;

use FOS\RestBundle\Controller\Annotations\Get;

class YourController
{
    /**
     * @Get("/api/v1/reps.{_format}", defaults={"_format"="json"})
     * @View()
     */
    public function indexAction()
    {
        return array(
            'status' => 'ok',
            'companies' => array(
                array('id' => 5),
                array('id' => 7),
            ),
        );
    }
}

Edit1:如果你不想使用 View 类，而是纯数组:不要忘记禁止 SensioExtraBundle 的 View 处理

sensio_framework_extra:
    view:    { annotations: false }

Edit2:如果你不使用 HTML 格式，只想有一个 json 输出，你可以使用这样的配置:

fos_rest:
    # ....
    format_listener:
        rules:
            - { path: ^/, priorities: [ json ], fallback_format: json, prefer_extension: true }
    # ....

解释为什么您看到错误“未找到 View ”:

TL;DR:您的浏览器发送一个 Accept header ，告诉 FOSRestBundle 输出“html”变体。

背景:该包主要与 Accept header 一起使用，最好使用所有可用的输出格式:html(您可以使用您提供的表单、对象列表、对象的详细信息轻松测试您的 REST API，这种方式很容易), json, xml.有时甚至图像 mime 类型，如默认的 image/jpeg、image/png 或作为变体的 json/xml(您可以使用 base64 图像表示)。

说明:如果您打开浏览器的“网络”选项卡并查看它发送的 header ，您会注意到类似这样的内容:text/html,application/xhtml+xml,application/xml;q=0.9, */*;q=0.8 意思是“按这样的顺序使用”:

1. 文本/html
2. 应用程序/xhtml+xml
3. application/xml 优先级为 0.9，根据您的配置这是被禁止的
4. */* 优先级 0.8 表示任何格式

如果仔细观察，您会发现根据您的配置 text/html 是您的配置具有 ('html') 和 */* 是另一个('json')，但是 text/html 的优先级为 1，而 */* 的优先级为 0.8，所以 text/html 匹配且 FOSRestBundle 尝试查找 HTML 表示但失败。

PS:如果您多次发布问题 - 请确保您关注每个线程中的所有回复。

关于php - FOSRestBundle 设置返回 JSON 但仍然要求 Twig 模板，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/30114152/