首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >如何使用NelmioApiDocBundle在POST请求中包含查询参数?

如何使用NelmioApiDocBundle在POST请求中包含查询参数?
EN

Stack Overflow用户
提问于 2016-02-23 08:50:12
回答 1查看 1.2K关注 0票数 1

我正在使用Symfony 3和NelmioApiDocbundle (这是我的新手)。我想处理一个具有可选查询参数的POST请求。url应该类似于:http://example.com/api/updateusers?token=some_long_value

这是我为我的注解所尝试的:

代码语言:javascript
复制
/**
 * 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沙箱进行测试和文档编制。

EN

回答 1

Stack Overflow用户

发布于 2017-03-30 15:14:50

试着在你的注释中添加这个,希望它能对你有所帮助。

代码语言:javascript
复制
@QueryParam(name="<your_name>", nullable=[true|false], requirements="\d+", description="<your_decription>")
票数 0
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/35566798

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档