使用@QueryParam的FOSRESTBundle路由

时间:2013-10-02 16:55:59

标签: symfony fosrestbundle api-doc

我正在使用Symfony 2.3.4和FOSRestBundle 0.13.1。 我已将路由配置为由FOSRestBundle自动生成。在我将@QueryParam注释添加到任何方法之前,Eveything非常有用。这个注释改变了路径,而不是从url中提取变量,它希望它作为参数传递。

/**
* @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注释?

1 个答案:

答案 0 :(得分:2)

通过使用QueryParam注释,您声明$user参数作为查询参数提供(如/api/user/details?user=foo),因此不再有动作参数留在路线中。

如果要向自动生成的路线添加要求,则必须改为使用@Rest\Route注释,如

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

请注意,没有与strictnullable选项等效的内容。如果未满足要求或缺少参数,则路由将不匹配,如果没有其他路由与请求匹配,则会导致404错误。此外,AFAIK无法将描述附加到路由参数。