Swagger中API查询参数的可能值列表

Question

在记录API时，有没有办法提供可能的值列表？像这样：

{
  "name": "propertyType",
  "in": "query",
  "description": "Type of home",
  "required": false,
  "type": "list",
  "listValues": ["singleFamilyHome", "condo", "farm", …]
}

Answer 1

在swagger 2.0中，您可以使用枚举：

exclude

您可以在此处找到更多信息：How to define enum in swagger.io?