如何告诉Swagger属性是Map

Question

我正在与Jersey一起提供宁静的服务。 但是，我正在使用Swagger进行文档编制。 我的模型具有地图类型的属性。 Swagger显示此属性为Object（不是特定类型）。 那么，如何告诉Swagger此属性来自Map类型？

public class Model {
    private String name;
    private Map<Integer, String> myMap;

    public Model(){
        super();
    }

    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public Map<Integer, String> getMyMap() {
        return myMap;
    }
    public void setMyMap(Map<Integer, String> myMap) {
        this.myMap = myMap;
    }
}

宁静的服务：

@POST
@Path("/createBundle")
@Consumes({MediaType.APPLICATION_JSON})
@ApiOperation(value = "Create Bundle ",
    notes = "",
    response = Model.class)
    public Model createBundle(Bundle bundle){
        return new Model();
    }

我需要Swagger将其显示为Map<Integer, String> 。

Swagger将文档显示为此图像。

Answer 1

您可以在@ApiOperation批注中设置响应类型：

@ApiOperation(value = "Find thingies as Map",
    notes = "Multiple thingies can be returned, <code>id</code> is the ID field",
    response = java.util.Map.class)