使用Swagger

时间:2019-11-28 13:54:57

标签: swagger openapi swagger-php

我想知道如何在响应中添加自定义属性。

目前,我有一个基本的答复:

JSON:

  

[{{id:1,...},{id:2,...}]

带有此注释:

 /**
 * @OA\Get(
 *     path="/countries",
 *     summary="List all countries",
 *     tags={"Countries"},
 *     @OA\Response(
 *         response="200",
 *         description="List countries success",
 *         @OA\JsonContent(type="array", @OA\Items(ref="#/components/schemas/Country"))
 *     )
 * )
 */

我想为一个示例添加自定义属性(消息,数据...):

JSON:

  

{消息:“列出所有成功的国家/地区”,数据:[{id:1,...},{id:2,...}]}

已修复

 /**
 * @OA\Get(
 *     path="/countries",
 *     summary="List all countries",
 *     tags={"Countries"},
 *     @OA\Response(
 *         response="200",
 *         description="List countries success",
 *         @OA\MediaType(
 *             mediaType="application/json",
 *             @OA\Schema(
 *                 type="object",
 *                 @OA\Property(
 *                      property="message",
 *                      type="string"
 *                 ),
 *                 @OA\Property(
 *                      property="data",
 *                      type="array",
 *                      @OA\Items(ref="#/components/schemas/Country")
 *                 )
 *             )
 *         )
 *     )
 * )
 */

https://github.com/zircote/swagger-php/issues/719

0 个答案:

没有答案