1

我正在使用（并且是新手）Symfony 3 和 NelmioApiDocbundle。我想处理具有可选查询参数的 POST 请求。网址将类似于： http ://example.com/api/updateusers?token=some_long_value

这是我为我的注释尝试过的：

/**
 * Returns a JSON object.
 *
 * @ApiDoc(
 *  resource=true,
 *  description="Update a user's information.",
 *  requirements={
 *      {
 *          "name"="userid",
 *          "dataType"="string",
 *          "requirement"=".+",
 *          "description"="the user to update"
 *      }
 *  },
 *  parameters={
 *    {"name"="data", "dataType"="text area", "required"=true, "description"="Free form xml data."}
 *  },
 *  filters={
 *    {"name"="token", "dataType"="string", "required"=true, "description"="auth token for current user - user that you're making the request on behalf of."},
 *  },
 * )
 * @Route("api/updateusers")
 * @Method("POST")
 */

要求、参数和过滤器都显示在 API 沙箱的 POST 正文中。我可以使用另一种定义类型来在 API 沙箱中显示查询参数吗？如果我绕过沙箱并将请求直接发送到服务器，则令牌会正确显示为 GET 值。但我希望能够使用 API 沙箱进行测试和记录。

4

1 回答 1

0

尝试将其添加到您的注释中，希望对您有所帮助。

@QueryParam(name="<your_name>", nullable=[true|false], requirements="\d+", description="<your_decription>")
于 2017-03-30T07:14:50.160 回答