Я пытаюсь создать документацию API, используя nelmioapibundle, используя аннотацию swagger.
/**
* @Route("/api/user/create", methods={"POST"})
* @SWG\Post(
* consumes={"application/json"},
* produces={"application/json"},
* tags={"Reg."},
* @SWG\Parameter(
* name="body",
* in="body",
* type="json",
* required=true,
* @SWG\Schema(
* type="object",
* @SWG\Property(type="string", property="postalCode",type="string",example="75056",required=true)
* )
* ),
* @SWG\Response(
* response=200,
* description="Returns user id",
* ),
* )
*
*/
Документация API успешно генерируется до тех пор, пока я не укажу свойство для postalCode .Когда я указываю required=true
, отображается приведенная ниже ошибка.
User Notice: @SWG\Property()->required is a "boolean", expecting a "[string]"
При поиске проблемы я обнаружил, что всякий раз, когда указан неизвестный тип данных, он будет считать тип [string]
, не увереноб этом, хотя.
Имеет ли @SWG \ Property () обязательный параметр?
Я использую "php": "^7.2", "symfony/framework-bundle": "4.3.*","nelmio/api-doc-bundle": "^3.4","zircote/swagger-php": "^2.0.9"
Другой способ указать свойство при необходимости?