【问题标题】:Dropwizard Swagger complex post Objects annotationsDropwizard Swagger 复杂帖子 Objects annotations
【发布时间】:2023-06-14 18:23:01
【问题描述】:

我正在使用带有 swagger 的 drop 向导来记录我的 rest 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){

}

【问题讨论】:

    标签: swagger dropwizard


    【解决方案1】:

    您似乎需要发布一个基于名为Parameters 的 POJO 的复杂值。确保你有一个类的无参数构造函数,并且你有 getter 和 setter。然后它会显示为一个带有json结构的body参数,其中包含param1、param2、param3,所有这些都是字符串。

    【讨论】: