java - 如何在 Swagger 中声明一个类型为条目列表

Question

我想“手动”声明一种字段类型，即 swagger 中的条目列表。

假设我完全自定义

public class MyCustomList implements List<MyValue> {
....
}

现在我有一个模型类

@Data
public class MyModel {
    public MyCustomList problematicField;
}

我想让 Swagger 理解 MyCustomList 是 MyValue 的列表(数组)。

在@ApiOperation中我设置了

@ApiOperation(value = "..", response = MyValue.class, responseContainer = "List")

Answer 1

我相信您可以使用自定义模型转换器来完成此任务。请参阅此处:

https://github.com/swagger-api/swagger-core/wiki/overriding-models

有关手动转换类的指南，但简而言之，它看起来像这样:

import com.wordnik.swagger.converter.*;

String jsonString = "{" +
"  \"id\": \"Date\"," +
"  \"properties\": {" +
"    \"value\": {" +
"      \"required\": true," +
"      \"description\": \"Date in ISO-8601 format\"," +
"      \"notes\": \"Add any notes you like here\"," +
"      \"type\": \"string\"," +
"      \"format\": \"date-time\"" +
"    }" +
"  }" +
"}";
OverrideConverter converter = new OverrideConverter();
converter.add("java.util.Date", jsonString);

ModelConverters.addConverter(converter, true);