@QueryParam的FOSRESBundle路由

Question

我使用的是Symfony 2.3.4和FOSRestBundle 0.13.1。我已经配置了由FOSRestBundle自动生成的路由。在我将@QueryParam注释添加到任何方法之前，一切都很好。这个注释改变了路由，而不是从url中提取varaible，而是希望将其作为参数传递。

i.e

/**
* @return array
* @Rest\View
*/
public function getDetailsAction($user) {
......
}

-bash-4.2$ php app/console router:debug 
get_details      GET    ANY    ANY  /api/users/details/{user}

但是，一旦我添加@QueryParam注释，我的路由就会更改为：

/**
* @QueryParam(name="user", requirements="\w+", strict=true, nullable=false, description="Name of the user to query details for")
* @return array
* @Rest\View
*/
public function getDetailsAction($user) {
......
}

-bash-4.2$ php app/console router:debug 
get_details      GET    ANY    ANY  /api/users/details

为什么我的路线变了？不能保留原始路由并同时使用@QueryParam注释吗？

Answer 1

通过使用QueryParam注释，您可以声明$user参数是作为查询参数(如/api/user/details?user=foo)提供的，因此在路由中不再需要包含更多的操作参数。

如果要向自动生成的路由添加需求，则必须使用@Rest\Route注释，如下所示

/**
 * @Rest\View
 * @Rest\Route(requirements={"user"="\w+"})
 */
public function getDetailsAction($user) {
-----
}

请注意，不存在与strict或nullable选项等效的选项。如果没有满足需求或缺少参数，则路由将根本不匹配，如果没有其他路由匹配请求，则会导致404错误。此外，AFAIK没有方法将描述附加到路由参数。