我有一个使用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
需求类型:
我想将参数重命名为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) // [...]
但现在它向我显示了两个参数:
从api doc覆盖或删除@param
代码的最佳方法是什么?没有删除它当然形成评论文档...
感谢您的帮助!