在OpenAPI中指定集合

Question

我正在使用OpenAPI/Swagger来指定我的API。

有一件事我找不到，那就是如何指定一个集合。

我正在使用https://editor.swagger.io/我输入了整个API。对于要指定为集的属性，我编写了以下代码：

   myProperty:
      uniqueItems: true
      type: array
      description: some description
      items:
        type: string

我本以为uniqueItems会起作用并生成一个Set，但事实并非如此。相反，生成了以下代码：

@JsonProperty("myProperty")
private List<String> myProperty = null;

有没有办法生成类似

@JsonProperty("myProperty")
private Set<String> myProperty = null;

而是？

我在SO中找到了一个可能的解决方案，但这需要在pom中进行一些配置。xml。然而，我使用的在线编辑器只提供了为不同平台生成代码的选项，但不接受pom文件。

Answer 1

OpenAPI（版本3）支持以下数据类型：

• 字符串
• 号码
• 整数
• 布尔值
• 数组
• 对象

OpenAPI v3中不支持集合数据类型。最接近的数据类型是属性uniqueItems设置为true的数组（如您所建议的）。但它仍然是一个对其项的唯一性有约束的数组，而不是一个集合。

因此，您的请求无法在OpenAPI级别上解决。

但是，代码生成器级别可能有一个选项，您需要将问题解决给您选择的代码生成器。