Swagger - 自定义示例请求正文

时间:2017-02-27 21:33:16

标签: java spring-mvc swagger

我有一个用于POST操作的swaggerized Spring MVC端点。该操作采用路径参数和(json)请求实体。生成swagger UI时,它会自动创建请求正文数据类型的示例值。此示例基于应用程序中的java实体。该实体用于其他一些操作,但是对于POST操作,我不希望在示例中公开某些实体字段。是否可以在不修改现有Java模型的情况下修改此示例?例如,是否可以在下面的示例lastUpdate中排除。

enter image description here

1 个答案:

答案 0 :(得分:1)

是的,可以使用jackson annotations lastUpdate忽略示例值中的JsonIgnore

import com.fasterxml.jackson.annotation.JsonIgnore;    

public class Phone {
  private String phoneNumber;
  private String lastUpdate;
  private int status;

  public String getPhoneNumber() {
    return phoneNumber;
  }
  public void setPhoneNumber(String phoneNumber) {
    this.phoneNumber = phoneNumber;
  }

  @JsonIgnore
  public String getLastUpdate() {
    return lastUpdate;
  }
  public void setLastUpdate() {
    this.lastUpdate = lastUpdate;
  }

  public int getStatus() {
    return lastUpdate;
  }
  public void setStatus() {
    this.status = status;
  }
}