java - Swagger - 自定义示例请求正文

Question

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

Answer 1

是的，可以使用 jackson 注释 JsonIgnore 忽略示例值中的 lastUpdate。

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