如何在Swagger中为GET请求生成模型/示例值部分

Question

我担心使用Swagger为我的GET请求生成Model / Example值部分。 The link官方示例完整地显示了该部分。

在官方文档中，它是使用现有模型生成的：

     *     @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：
github.com/zircote/swagger-php/.../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")
 *             )
 *         ),
...