Swagger Integer类型会导致一个预期的错误`falue for Value，get`1`

Question

我正在尝试描述身体参数，但有错误。这是我的swagger.json文件：

{
  "swagger": "2.0",
  "info": {
    "title": "Simple API overview",
    "version": "v2"
  },
  "host": "localhost:4000",
  "basePath": "/",
  "paths": {
    "/user/register": {
      "post": {
        "operationId": "register",
        "summary": "User registration",
        "parameters": [{
          "in": "body",
          "name": "role",
          "required": true,
          "schema": {
            "type": "integer",
            "example": 1
          }
        }]
      }
    }
  }
}

当我尝试运行它时，我会发现一个错误：

Error: Expected `string` for value, got `1`

如果删除示例字段，我在示例值部分中得到了此信息：

{}

看起来像类型定义是不正确的，但是我无法弄清楚我的代码和Swagger文档示例有什么区别。

Answer 1

我发现原因是：应该有消耗字段定义为text/plain。默认情况下，它是application/json。

完整代码：

{
  "swagger": "2.0",
  "info": {
    "title": "Simple API overview",
    "version": "v2"
  },
  "host": "localhost:4000",
  "basePath": "/",
  "paths": {
    "/user/register": {
      "post": {
        "operationId": "register",
        "summary": "User registration",
        "consumes": ["text/plain"],
        "parameters": [{
          "in": "body",
          "name": "role",
          "required": true,
          "schema": {
            "type": "integer",
            "example": 1
          }
        }]
      }
    }
  }
}

Answer 2

解决此错误的一种方法是将类型从整数更改为字符串。

"parameters": [{
  "in": "body",
  "name": "role",
  "required": true,
  "schema": {
    "type": "string",
    "example": "1"
  }
}]