在同一终结点上支持两个不同的请求正文

Question

我需要为同一端点和同一方法(POST(支持两种请求正文。在招摇中可能吗？

这很重要，因为两个请求正文都是有效的，用户可以发送其中一个。更具体地说，

请求正文 1：

{
    param1: value1
    param2: value2
    param3: {
        param3Key1:  x1
        param3Key2:  x2
        ...
    }
}

请求正文 2：

{
    param1: value1
    param2: value2
    param4: {
        differentKey1:  y1
        differentKey2:  y2
        ...
    }
}

有没有办法在 Swagger 中记录这种情况？

一种方法是将 param3 和 param4 都保留在文档中。但是，我希望用户特别知道只需要传递其中一个。我想为这两种情况提供一个完全不同的请求正文。

Answer 1

找不到直截了当的方法。这是我现在遵循的解决方法：

假设端点/endpoint 。我可以通过附加 # 后跟一个字符串在 swagger-ui 中创建 2 个端点：

/endpoint#1

/endpoint#2

然后，我可以在每个端点下分别定义我的两个请求正文。swagger中的curl命令将隐藏哈希 - 因此，两个端点基本相同。