Swagger - 具有未知键的键值对数组

Question

我正在尝试编写 Swagger API 文档，但我遇到了一个特定场景的问题。

我有一个巨大的网格，每个网格中都有 id 引用（想想棋盘），我想发送已更改的网格引用和每个中的新 ID。所以我可能有一个 40x40 的网格，我将其中一个网格正方形更改为不同的值。

我想发送到我的 API：

12x21 = 12345
23x11 = 87654
42x01 = 12987
23x09 = 19283

无需将 swagger 中的每个网格位置作为参数列出，我如何使用 Swagger UI 来表示此场景？

Answer 1

我会设计一个端点，您将更改作为 PUT 请求（或 POST 请求，如果它是一个新 id，很难从上下文中分辨出来），实际更改作为您请求的 JSON 正文.然后可以将对网格的引用作为查询参数或作为 JSON 正文的一部分发送。