如何在 Swagger open api 3.0 中定义常量字符串 [重复]答案

【问题标题】：How to define constant string in Swagger open api 3.0 [duplicate]如何在 Swagger open api 3.0 中定义常量字符串 [重复]
【发布时间】：2018-08-10 06:09:40
【问题描述】：

swagger open api 3.0 中如何定义常量字符串变量？如果我定义枚举，它将如下所示

"StatusCode": {
        "title": "StatusCode",
        "enum": [
          "success",
          "fail"
        ],
        "type": "string"          

 }

但是枚举可以是值列表，有没有办法在swagger open api 3.0中定义字符串常量

代码可以从http://editor.swagger.io/执行

【问题讨论】：

您只需要一个具有单个值的enum。

标签： swagger openapi

【解决方案1】：

正如@Helen 已经指出的那样，并且您可以在链接的答案中阅读，目前它似乎没有比只有一个值的enum 更好。可以粘贴到http://editor.swagger.io/的完整示例：

{
  "openapi": "3.0.0",
  "info": {
    "title": "Some API",
    "version": "Some version"
  },
  "paths": {},
  "components": {
    "schemas": {
      "StatusCode": {
        "title": "StatusCode",
        "enum": [
          "The only possible value"
        ],
        "type": "string"
      }
    }
  }
}

Github 上有一个相关话题，目前尚未解决： https://github.com/OAI/OpenAPI-Specification/issues/1313

【讨论】：

那么const字符串数组如何？

【解决方案2】：

您可以将常量参数定义为只有一个可能值的必需参数

但如果你有多个参数，它就不能是一个常数。在api中，如果有多项选择，所有值都可以更改。

参考： https://swagger.io/docs/specification/2-0/describing-parameters/

【讨论】：