Swagger 文档 - 如何在 json 请求正文中仅获取以逗号分隔的值？

Question

在我的例子中，对于 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",
 *     description="Segment Name",
 *     property="Vi####002"
 * )
 *
 * @var string
 */

}

swagger.php

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

非常感谢任何帮助。

提前致谢

Answer 1

您当前的设置描述了一个对象，但看起来您想要一个包含字符串的简单数组

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

为了更加清晰，您可以提供一种格式 @OA\Items(type="string", format="id"),，该格式会被工具忽略，但会提示文档的 reader。

Swagger 文档 - 如何在 json 请求正文中仅获取以逗号分隔的值？

Swagger Documentation - How can i get only values separated by a comma in the json request body?

annotations

swagger

swagger-php