我有一个使用 ParamConverter Symfony 服务的 REST 控制器,使用 nelmio api doc annotation:
<?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 文档已正确呈现,但显示了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) // [...]
但现在它向我展示了两个参数:
@param
从 api doc 覆盖或删除标签的最佳和正确方法是什么?当然,如果不将其从评论文档中删除...
谢谢你的帮助!