fos rest symfony2中的自定义获取URL

时间:2015-02-18 07:56:08

标签: php rest symfony phpunit fosrestbundle

我需要在我的api中创建一个自定义网址。我正在使用fos rest bundle。

自定义网址如下:

http://myapi.com/api/v1/public/users/confirm?cd=<some_code>.json

我试过了:

@GET("/users/confirm?cd={cd}")

当我跑步时:

php /app/console route:debug

我得到了这个:

...
....
get_confirm GET ANY ANY  /api/v1/public/users/confirm?cd={cd}.{_format}
...
...

但在我的测试中,当我尝试点击此网址时,我得到:

No route found for &quot;GET /api/v1/public/users/confirm&quot; (404 Not Found)

任何人都可以帮助我。如何形成这样的URL。

我的控制器操作代码:

/*
 * @GET("/users/confirm?cd={cd}")
 */
public function getConfirmAction($cd) {

    //Some code for user confirmation

    return return View::create(array('successmessage'=>'Your account has been verified successfully. Please login.', Codes::HTTP_OK);
}

PHPUnitTest代码:

public function testGetConfirmThrowsInvalidArgumentException() {
    $this->client->request(
                'GET', '/api/v1/public/users/confirm?cd=abcd123.json'
        );

        $response = $this->client->getResponse();

        print_r($response->getContent());
        exit(__METHOD__);
}

2 个答案:

答案 0 :(得分:2)

同意@john评论: 您不需要将查询参数添加到路线定义

我想基本上你想要一个随URL提供的参数。如果这是您的要求,那么FOSRestBundle具有称为 param fetcher 的很酷的功能。有了它,您可以使用注释定义查询字符串参数,允许它们是否可为空,设置默认值,定义要求。

对于你的情况,如果你期望cd是一个数字,那么你可以注释为

@QueryParam(name="cd", nullable=true, requirements="\d+")

请参阅以下示例代码

/*
* function desc
* @QueryParam(name="cd", nullable=true, requirements="\d+")
* @param ParamFetcher $paramFetcher
*/
public function getConfirmActionAction(ParamFetcher $paramFetcher)
{
   //access the parameter here
    foreach ($paramFetcher->all() as $name => $value) {
        echo $name."==>". $value;
    }

}

答案 1 :(得分:1)

您不需要将查询参数添加到路线定义

他们也会在完整的网址之后,例如在“.json”

之后

即:

/api/v1/public/users/confirm.json?cd=ejwffw

所以我没有使用注释路由定义,但它应该是这样的:

@GET("/users/confirm.{_format}")

在您的操作中,您可以通过请求访问您的参数

喜欢:

$request=$this->getRequest();
$code = $request->get('cd') ? $request->get('cd') : false;