我是Swagger的新手,我正在尝试了解如何定义哪些模型属性是必需的,哪些不应该为每个操作发送。
例如,在注册用户属性first_name
时,需要last_name
,email
和password
。但是,在更新其他属性时不需要这些。此外,永远不应发送某些属性,例如role
。
我目前有这个:
/**
* @SWG\Post(
* path="/user/register",
* summary="Registers a new user",
* consumes={"application/json"},
* required={"first_name","last_name"},
* @SWG\Parameter(
* name="User",
* description="User attributes",
* in="body",
* required=true,
* type="string",
* @SWG\Schema(ref="#/definitions/User")
* ),
* @SWG\Response(
* response=200,
* description="User object",
* @SWG\Schema(
* @SWG\Items(ref="#definitions/User")
* )
* )
* )
*/
我想补充一下:
required={"first_name","last_name","email","password"},
ignore={"role","registration_date","status"},
这些事情可能吗?