Dropwizard Swagger 複雜的 post Objects 注释

Question

我正在使用带有大摇大摆的拖放向导来记录我的休息 api。我首先向现有资源类添加注释以生成文档。但是现在我有一个发布请求，我需要发布自定义模型，例如下面的参数。

  public class Parameters {
    private final String param1;
    private final String param2;
    private final String param3;
    public Parameters(String param1, String param2, String param3) {
        super();
        this.param1 = param1;
        this.param2 = param2;
        this.param3 = param3;
    }
    public String getParam1() {
        return param1;
    }
    public String getParam2() {
        return param2;
    }
    public String getParam3() {
        return param3;
    }
}

我像下面这样注释了 post 方法，但没有为这种方法生成文档，任何人都可以指导我朝着正确的方向工作吗？

@POST
    @Path("/add/params")
    @ApiOperation(value = "Adding params")
public Response addParams(@ApiParam(required = true)Parameters params){
}

Answer 1

看起来您需要基于名为 Parameters 的 POJO 发布一个复杂的值。 确保你有一个类的无参数构造函数，并且你有getters和setters。 然后它将显示为一个带有 json 结构的主体参数，其中包含 param1、param2、param3，全部作为字符串。