Описание свойств для Swagger в Symfony

Опубликован в чт, 02/18/2021 - 12:17

При разработке на Symfony в описании сущностей в аннотациях нужно описывать поля для Swagger-а. Пример:

		/**
		* @OA\Schema(
		*   schema="Some",
		*   description="Какое-то описание сущности",
		*   @OA\Property(property="id", type="integer", description="ID"),
		*   @OA\Property(property="title", type="string",description="Наименование"),
		*   @OA\Property(property="some_property", type="boolean",description="Какое-то булево значение"),
		*   @OA\Property(property="some_property_1", ref="#/components/schemas/Dictionary"),
		* )
		*
		* @ORM\Entity(repositoryClass=SomeRepository::class)
		* @ORM\Table(options={"comment":"Комментарий"});
	*/

С помощью аннотации @OA\Property мы описываем типы свойств в соответствии с этой таблицей https://swagger.io/specification/#data-types

В общем и целом для работы с аннотациями в Swagger можно ознакомиться по этой ссылке https://github.com/zircote/swagger-php/blob/master/docs/Getting-started.md

Тэги:

Тэг в списке: