Question

我在Swagger中描述了一个POST端点，我希望该端点也具有查询参数。我们使用1.2宽幅格式，是因为遗留原因。我们使用3scale，它托管文档，您可以在其Web UI中编辑您的招摇。但是，当我尝试保存文档时，出现以下错误。

JSON Spec can not have paramType='body' and paramType='query' on the same method

在招摇的规格中我找不到任何表明这是实际限制的东西。这可能是3Scale特有的，还是一般的限制？如果是后者，有人可以指出我的规格是否可以澄清它？

实际的REST端点无关紧要，它对POST上的查询参数感到满意。只是让Swagger工具感到高兴。这是swagger文档的简短代码段：

{
  "parameters": [
    {
      "name": "myQueryParam",
      "dataType": "string",
      "paramType": "query",
      "required": true
    },
    {
      "name": "body",
      "dataType": "string",
      "paramType": "body",
      "required": true
    }
  ],
  "httpMethod": "POST"
}

Answer 1

不确定错误消息是否为通用验证错误，但是您共享的规范中存在一些错误：

这是“方法”而不是“ httpMethod”
它是“类型”而不是“ dataType”

https://github.com/OAI/OpenAPI-Specification/blob/master/versions/1.2.md

昂首阔步：不允许在POST方法上查询参数？

1 个答案: