Swagger文档-如何在JSON请求正文中仅获取用逗号分隔的值?

问题描述

就我而言,对于DELETE操作,我将必须传递一个如下所示的正文。

请求正文应如下所示:

[
 "Vi####1","Vi####2"
]

但是当我尝试实现这一目标时,我总是获得数据类型以及如下所示的值。

当前正在创建的请求正文:

{
 "Vi####1": "string","Vi####2": "string"
}

请在json创建下方找到。

class VirtualViewColDeleteReq
{

/**
 * @OA\Property(
 *     title="View ID",*     description="Segment Name",*     property="Vi####001"
 * )
 *
 * @var string
 */

/**
 * @OA\Property(
 *     title="View ID1",*     property="Vi####002"
 * )
 *
 * @var string
 */

}

swagger.PHP

 *     @OA\RequestBody(
 *          required=true,*          @OA\JsonContent(ref="#/components/schemas/VirtualViewColDeleteReq")
 *      ),

我们非常感谢您的帮助。

预先感谢

解决方法

您当前的设置是描述一个对象,但是看起来您想要一个带有字符串的简单数组

 *     @OA\RequestBody(
 *       required=true,*       @OA\JsonContent(
 *         type="array",*         @OA\Items(type="string"),*       )
 *     )

为更加清楚起见,您可以提供一种格式@OA\Items(type="string",format="id"),,该格式会被工具忽略,但会向文档的读者提供提示。