Swagger:不允许在POST方法上查询参数？

Question

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

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

我在swagger规范中找不到任何说明这是一个实际限制的东西。这可能是特定于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

不确定错误消息是否是一般的验证错误，但在您共享的规范中有几个错误：

• it is“"httpMethod"
• it”and not type is“”and not "dataType"

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

Answer 2

以下示例适用于我，但我使用的是required=false：

 {
        "in": "query",
        "name": "myQueryParam",
        "required": false,
        "type": "string"
 }

另请参阅Swagger parameters in query and/or body