Swagger Editor 显示架构错误：不完全是定义中的一个答案

【问题标题】：Swagger Editor showing schema error: is not exactly one from definitionsSwagger Editor 显示架构错误：不完全是定义中的一个
【发布时间】：2017-05-16 02:33:43
【问题描述】：

Swagger 编辑器在输入 JSON 中显示以下错误。

路径中的架构错误。/accord/stakeholderMaster/stakeholderLocationDetails.get.parameters[0] 不完全是 ,

中的一个

这是我的 JSON，

{
  "swagger": "2.0",
  "info": {
    "version": "1.0.0",
    "title": "Title",
    "description": "description"
  },
  "basePath": "/api",
  "paths": {
    "/accord/stakeholderMaster/stakeholderLocationDetails": {
      "get": {
        "description": "Returns stakeholder location details",
        "operationId": "findMovies",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "stakeHolderId",
            "description": "Stakeholder ID",
            "required": true,
            "type": "integer",
            "schema": {
              "$ref": "#/definitions/stakeHolder"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation",
            "schema": {
              "$ref": "#/definitions/stakeHolder"
            }
          }
        }
      }
    }
  },
  "definitions": {
    "stakeHolder": {
      "type": "object",
      "properties": {
        "stakeHolderId": {
          "type": "integer"
        },
        "chartTerm": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "label": {
                "type": "string"
              },
              "value": {
                "type": "string"
              }
            }
          }
        },
        "chartContent": {
          "type": "object",
          "properties": {
            "countSeriesOne": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "nameSeriesOne": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "chartLimit": {
              "type": "integer"
            },
            "receivableChartTerm": {
              "type": "integer"
            },
            "payableChartTerm": {
              "type": "integer"
            },
            "chartTerm": {
              "type": "integer"
            },
            "urlList": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}

【问题讨论】：

标签： json swagger swagger-editor

【解决方案1】：

该错误是由于参数定义中in、type和schema关键字组合不正确造成的。

首先，您的操作是 GET，但有一个请求正文（"in": "body" 参数）。 GET does not have defined semantics 中的请求正文。

我猜stakeHolderId 应该是路径参数：

GET /.../stakeholderLocationDetails/{stakeHolderId}

或查询参数：

GET /.../stakeholderLocationDetails?stakeHolderId=12345

所以参数应该是"in": "path" 或"in": "query" 而不是"in": "body"。如果是路径参数，还要更改路径以包含参数名称："/accord/stakeholderMaster/stakeholderLocationDetails/{stakeHolderId}"。如果是查询参数，请保持路径不变（查询参数不包含在路径中）。

同时从参数定义中删除schema。路径和查询参数只使用type； schema 关键字仅用于正文参数。

【讨论】：

非常感谢。正是我想要的。