如何在 Swagger 中为 GET 请求生成 Model/Example 值部分

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")
 *             )
 *         ),
...

如何在 Swagger 中为 GET 请求生成 Model/Example 值部分

How to generate Model/Example value section for GET request in Swagger

swagger

swagger-php