Question

我正在使用drop向导和swagger记录我的休息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发布复杂值。确保你有一个no-arg构造函数，并且你有getter＆amp; setter方法。然后它将显示为包含param1，param2，param3的json结构的body参数，全部为字符串。

Dropwizard Swagger复杂帖子对象注释

1 个答案: