如何设置参数值在nelmio api doc中可以为null?

时间:2019-02-19 09:51:50

标签: php symfony swagger nelmioapidocbundle

我在Symfony Flex中有一个API,该文档通过使用NelmioApiDocBundle进行了记录。在文档中,我想显示parentPOSId参数可以是int或null。我该怎么办?

这是我的控制器注释:

 /**
 *
 * @FOSRest\Post("/pos/parent")
 *
 * @SWG\Post(
 *     tags={"pos_parent"},
 *     description="set POS parent",
 *     @SWG\Response(
 *       response=200,
 *       description="Parent was set",
 *       examples={
 *          "application/json":{
 *              "POSId":2,
 *              "parentPOSId": 1
 *          }
 *       }
 *     ),
 *
 *     @SWG\Parameter(
 *         name="form",
 *         in="body",
 *         description="Action parameters",
 *         @Model(type=App\Domain\Port\POSParent\SetPOSParentInterface::class)
 *     )
 * )
 *
 */

这是我的模特

namespace App\Domain\Port\POSParent;

interface SetPOSParentInterface
{
    public function getPOSId():int;

    public function getParentPOSId():?int;
}

0 个答案:

没有答案