Как создать секцию значений модели / примера для запроса GET в Swagger

Question

Я обеспокоен созданием раздела значения Model/Example для моего запроса GET с помощью Swagger. Ссылка на официальный пример отлично показывает этот раздел.

В официальных документах он генерируется с использованием существующей модели:

     *     @SWG\Schema(ref="#/definitions/User")

У меня нет такой опции, потому что мои свойства создаются REST.

Я пробовал следующий способ:

/**
 * @SWG\Get(
...
 *     @SWG\Response(
 *         response="200",
 *         description="Ok",
 *         @SWG\Schema(
 *             type="array",
 *             @SWG\Property(property="firstname", type="string", example="Steven")
 *         ),
 *     ),
 * )
 */

Это не работает и ответы:

fetching resource list: http://localhost/dist/swagger.json; Please wait.

Любая помощь высоко ценится. Заранее спасибо.

Answer 1

GET /pet/findByStatus генерируется в одном из примеров:
https://github.com/zircote/swagger-php/blob/master/Examples/petstore.swagger.io/controllers/PetController.php

Причина, по которой ваш фрагмент не работает, заключается в том, что вы добавляете свойство к array тип, который не поддерживается.

Для описания содержимого массива вам понадобится @SWG\Items аннотация:

...
 *         @SWG\Schema(
 *             type="array",
 *             @SWG\Items(
 *                 type="object",
 *                 @SWG\Property(property="firstname", type="string", example="Steven")
 *             )
 *         ),
...