Swagger ApiModelProperty不工作

时间:2015-10-02 04:27:52

标签: java swagger

我在招摇时遇到了@ApiModelProperty的问题。在我的模型中,我使用@ApiModelProperty这样的

private static final long serialVersionUID = -7142106197262010406L;

private int brandId;
private String brandName;
private String fullName;
private String webSite;
private String logoUrl;
private String note;

@ApiModelProperty(position = 1, required = true, value="")
public int getBrandId() {
    return brandId;
}

public void setBrandId(int brandId) {
    this.brandId = brandId;
}

@ApiModelProperty(position = 2, required = true)
public String getBrandName() {
    return brandName;
}

public void setBrandName(String brandName) {
    this.brandName = brandName;
}

@ApiModelProperty(position = 3, required = true)
public String getFullName() {
    return fullName;
}

public void setFullName(String fullName) {
    this.fullName = fullName;
}

@ApiModelProperty(position = 4, required = true)
public String getWebSite() {
    return webSite;
}

public void setWebSite(String webSite) {
    this.webSite = webSite;
}

@ApiModelProperty(position = 5, required = true)
public String getLogoUrl() {
    return logoUrl;
}

public void setLogoUrl(String logoUrl) {
    this.logoUrl = logoUrl;
}

@ApiModelProperty(position = 6, required = true)
public String getNote() {
    return note;
}

public void setNote(String note) {
    this.note = note;
}

我不明白为什么@ApiModelProperty无法正常工作。谁可以帮我解决这个问题。请。谢谢大家!

3 个答案:

答案 0 :(得分:1)

您是否使用@ApiModel注释了您的课程?

@ApiModel
public class Brand{

   private String brandName;
   //...

    @ApiModelProperty(position = 1, required = true, value="")
    public int getBrandId() {
        return brandId;
    }

    public void setBrandId(int brandId) {
        this.brandId = brandId;
    }

    //...
}

答案 1 :(得分:0)

类应具有@ApiModel批注,字段或类的getter / setter应具有@ApiModelProperty批注。

请参考文档链接-http://docs.swagger.io/swagger-core/apidocs/com/wordnik/swagger/annotations/ApiModelProperty.html

我希望它能起作用。

谢谢, Mahesh Mane。

答案 2 :(得分:-3)

@ApiModelProperty应该是字段级别而不是方法级别。 将这些注释移动到您拥有变量声明的顶级。