web-dev-qa-db-ja.com

Swagger open api 3.0で定数文字列を定義する方法

Swagger Open API 3.0で定数文字列変数を定義するにはどうすればよいですか？列挙型を定義すると、次のようになります

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

 }

しかし、列挙型は値のリストにすることができます。swaggeropen api 3.0で文字列定数を定義する方法はありますか

コードは http://editor.swagger.io/ から実行できます

swaggeropenapi
6
Harsha Gayan

@Helenがすでに指摘したように、リンクされた回答を読むとわかるように、現在のところ、値が1つだけの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/131

0
Dirk