swagger - OpenAPI (Swagger) で列挙型を定義するには?

Question

Swagger UI の [モデル] タブに表示されるように、OpenAPI 2.0 定義で可能な「列挙型」値を定義する方法を知っている人はいますか? 例: https://petstore.swagger.io/#!/pet/addPetには、プロパティの列挙オプションがありstatusます。OpenAPI 2.0 でそのような列挙型を定義するにはどうすればよいですか?

Answer 1

これを YAML 構文で更新します。

OpenAPI 2.0:

parameters:
  - in: query
    name: sample
    description: a sample parameter with an enum value
    type: string
    enum:
      - 1
      - 2
    required: true

OpenAPI 3.0:

parameters:
  - in: query
    name: sample
    description: a sample parameter with an enum value
    schema:
      type: string
      enum:
        - 1
        - 2
    required: true

Answer 2

これはうまくいくはずです：

{
    "name": "bookingType",
    "in": "path",
    "type": "array",
    "items": {
        "enum": [
            "packages", "accommodations"
        ]
    },
    "description": "lorem ipsum"
}

参照https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#itemsObject

Answer 3

これは正確な答えではありませんが、この機能が追加されるまではうまくいくかもしれません.

プロパティを次のように宣言するだけです

"MyObject":{
   "properties":{
      "MyEnum":{
         "type":"Value1 or Value2 or Value3"
      }
   }
}

ModelSchema は表示されます{}が、モデルは表示されますMyEnum(Value1 or Value2 or Value3, optional)