在nelmio api doc上覆盖@param doc

时间:2015-02-12 19:07:41

标签: rest api symfony nelmioapidocbundle

我有一个使用ParamConverter Symfony服务的REST控制器,使用nelmio api doc注释:

<?php

    /**
     * @param Plan $plan The plan id
     *
     * @ApiDoc(
     *  description="Returns plan details",
     *  output={
     *      "class"="AppBundle\Entity\Plan",
     *      "groups"={"details"}
     *  }
     * )
     *
     * @return Response
     */
    public function getAction(Plan $plan) // [...]

api doc已正确呈现,但显示Plan需求类型:

enter image description here

我想将参数重命名为plan_id并指定integer类型。

所以我尝试使用requirements选项,如下所示:

<?php

    /**
     * @param Plan $plan The plan id
     *
     * @ApiDoc(
     *  description="Returns plan details",
     *  requirements={
     *      {
     *          "name"="plan_id",
     *          "dataType"="integer",
     *          "requirement"="\d+",
     *          "description"="The plan's id"
     *      }
     *  },
     *  output={
     *      "class"="AppBundle\Entity\Plan",
     *      "groups"={"details"}
     *  }
     * )
     *
     * @return Response
     */
    public function getAction(Plan $plan) // [...]

但现在它向我显示了两个参数:

enter image description here

从api doc覆盖或删除@param代码的最佳方法是什么?没有删除它当然形成评论文档...

感谢您的帮助!

0 个答案:

没有答案