在NelmioApiDocBundle中设置'parameters'注释

时间:2013-02-01 01:06:42

标签: symfony symfony-2.1 fosrestbundle api-doc

我使用带有FOSRESTBundle的Symfony2.1创建了一个API RESTfull,我使用NelmioApiDocBundle来生成自动文档。

我有一个PUT请求,其中用户应该发送一个参数,但我不需要为此目的创建一个表单。一切都很完美,但是当我生成文档时,我不知道如何将此参数添加到文档中,因为我没有“输入”表单。

我尝试了这个,但似乎不起作用:

 /**
 * @ApiDoc(
 *  description="description",
 *  statusCodes={
 *         200="Success",
 *         400="Bad request"},
 *  parameters={
 *         {"name"="parameter_name", "dataType"="integer"}
 *  }
 * )
 ...

NelmioApiDocBundle的文档中,我没有看到任何解决方案......

1 个答案:

答案 0 :(得分:0)

使用过滤器键而不是参数

 * filters={
 *     {"name"="parameter_name", "dataType"="integer"},
 * },