Я использую Swagger UI, и у меня есть Get API, которые принимают по желанию принять
параметр, но я не могу дать аннотацию для этого API ниже
сделать код, который я попробовал:
/**
* @SWG\Get(
* path="/basics/checkDataNameAvailability/{type}/{name}{/id}",
* tags={"Emergency"},
* description="Return data useful for userGroup, deviceGroups and deviceTags",
* produces={"application/json", "application/xml", "text/xml", "text/html"},
* @SWG\Parameter(name="type",in="path",description="return useful data by type",required=true,type="integer", @SWG\Items(type="integer"),collectionFormat="csv",format="int32"),
* @SWG\Parameter(name="name",in="path",description="return useful data by name",required=true,type="integer", @SWG\Items(type="integer"),collectionFormat="csv",format="int32"),
* @SWG\Parameter(name="id",in="path",description="optional, useful data by id",required=true,type="integer", @SWG\Items(type="integer"),collectionFormat="csv",format="int32"),
* @SWG\Response(response=200,description="Dashboard Response",
* @SWG\Schema(type="array",@SWG\Items(ref="#/definitions/Pet"))
* ),
* @SWG\Response(response="default",description="unexpected error",
* @SWG\Schema(ref="#/definitions/ErrorModel")
* ),
* @SWG\ExternalDocumentation(description="find more info here", url="https://swagger.io/about")
* )
*/
и моя структура Get API выглядит так:
$app->get('/checkDataNameAvailability/:type/:name(/:id)', function($type, $name, $id = '') use($app){
//here is my api code
});
Но когда я пытаюсь это так развязный пользовательский интерфейс не берет Я бы необязательный параметр, он принимает обязательный параметр, помогите мне ..
Чтобы определить необязательный параметр, вам просто не нужно определять его как Не требуется.
id
параметр имеет required=true
:
@SWG\Parameter(name="id",in="path",description="optional, useful data by id",required=true,type="integer", @SWG\Items(type="integer"),collectionFormat="csv",format="int32")
Вам просто нужно установить его в false:
@SWG\Parameter(name="id",in="path",description="optional, useful data by id",required=false,type="integer", @SWG\Items(type="integer"),collectionFormat="csv",format="int32")
Удаление required=true
также сделайте этот параметр необязательным
@SWG\Parameter(name="id",in="path",description="optional, useful data by id",type="integer", @SWG\Items(type="integer"),collectionFormat="csv",format="int32")
Других решений пока нет …