如何在Swagger OpenAPI 3.0中定义常量字符串

Question

如何在Swagger OpenAPI 3.0中定义常量字符串变量？如果我定义枚举，它将如下所示

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

 } 

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

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

- Harsha Gayan

---

你只需要一个只有一个值的enum。 - Helen

Answer 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

- Dirk

---

那么如何定义常量字符串数组？ - Jiang YD

Answer 2

您可以将常量参数定义为仅具有一个可能值的必填参数。但是，如果您有多个参数，则不能是常量。在API中，如果有多个选择，则所有值都可以更改。

Ref: https://swagger.io/docs/specification/2-0/describing-parameters/

- znndrd