10

使用 Symfony2 和 FOSRestBundle 我正在尝试实现 API 方法，这些方法在路由中定义了一些固定参数以及查询字符串中可能存在的一些可选参数。

例如：

 http://somesite.com/api/method/a/b
 http://somesite.com/api/method/c/d?x=1&y=2

根据FOSRestBundle 的文档，ParamFetcher 是使用 @QueryParam 注释的正确方法。但是，我已经定义了一个控制器，如下所示：

 use Symfony\Bundle\FrameworkBundle\Controller\Controller;
 use FOS\RestBundle\Controller\Annotations\Get;
 use FOS\RestBundle\Controller\Annotations\View;

 class MyController extends Controller
 {

   /**
    * @Get("/method/{a}/{b}")
    * @View()
    */
   public function getMethodAction($a, $b)
   {
     // do stuff

     return array('foo' => 'bar');
   }

 }

现在看来我需要能够访问 ParamFetcher 的实例，但我不知道如何（谷歌搜索没有太大帮助）。我从文档中知道，我可以简单地更改方法签名以合并 ParamFetcher，但是，当我这样做时，它会将参数移动到我无法拥有的查询字符串中。

有没有办法混合两者，或者我应该放弃 ParamFetcher 并直接使用 Symfomy 的内置 Request 对象检查请求？

4

2 回答 2

15

这个问题已经很老了，您可能已经找到了解决方案，但是自从我通过 Google 搜索来到这里并且知道答案后，我会做出贡献。

use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\JsonResponse;
use FOS\RestBundle\Request\ParamFetcher;
use FOS\RestBundle\Controller\Annotations\QueryParam;
use Nelmio\ApiDocBundle\Annotation\ApiDoc;

class DefaultController extends Controller
{
    /**
     * Returns a collection of Task
     *
     * @QueryParam(name="projectId", nullable=true, requirements="\d+")
     * @QueryParam(name="name", nullable=true, description="Project Name")
     * @QueryParam(name="assignee", nullable=true)
     * @QueryParam(name="depth", nullable=true)
     *         *
     * @param ParamFetcher $paramFetcher
     * @ApiDoc()
     *
     * @return JsonResponse
     */
    public function cgetTaskAction(ParamFetcher $paramFetcher)
    {
        foreach ($paramFetcher->all() as $criterionName => $criterionValue) {
            // some logic here, eg building query
        }

        $results = // query database using criteria from above

        // this is just a simple example how to return data
        return new JsonResponse($results);
    }
}
于 2013-09-18T20:02:24.463 回答
6

只是想发布一个答案，因为原始答案仅使用 QueryParams，而问题是将 QueryParams 与 RouteParams 一起使用。

如果要使用路由参数和查询参数，可以使用 ParamFetcher 作为操作的第一个参数，稍后再添加路由参数。

我还没有找到将路由参数添加到 paramFetcher 的方法。

/*
 * @Route("/term/{termId}", requirements={"termId" = "[a-z0-9]+"})
 *
 * @QueryParam(name="limit", requirements="\d+", default="30", description="How many documents to return.")
 *
 * @Method("GET")
 *
 * @param ParamFetcherInterface $paramFetcher
 * @param $termId
 * @return array()
 */
public function getTermFeedAction(ParamFetcherInterface $paramFetcher, $termId) {
    // access $termId over the method parameter
    // access the @queryparams via the $paramFetcher

}
于 2014-03-06T17:18:10.180 回答