Swagger ApiModelProperty not working

问题

I have a problem with @ApiModelProperty in swagger. In my model, I use @ApiModelProperty like this

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;
}

I don't understand why @ApiModelProperty not working. Who can help me how to resolve this problem. Please. Thanks everyone!

回答1:

Did you annotate your class with @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;
    }

    //...
}

回答2:

The @ApiModelProperty Should be field level not method level. Move those annotations to top level where you have the variable declaration.

来源：https://stackoverflow.com/questions/32900551/swagger-apimodelproperty-not-working

标签

java

swagger