Java Swagger-自定义示例请求正文
我有一个夸张的SpringMVC端点用于POST操作。该操作采用路径参数和(json)请求实体。生成swagger UI时,它会自动创建请求正文数据类型的示例值。此示例基于应用程序中的java实体。实体用于其他一些操作,但是对于POST操作,我不希望在示例中公开一些实体字段。是否可以在不修改现有java模型的情况下修改此示例?例如,是否可以在下面的示例中排除Java Swagger-自定义示例请求正文,java,spring-mvc,swagger,Java,Spring Mvc,Swagger,我有一个夸张的SpringMVC端点用于POST操作。该操作采用路径参数和(json)请求实体。生成swagger UI时,它会自动创建请求正文数据类型的示例值。此示例基于应用程序中的java实体。实体用于其他一些操作,但是对于POST操作,我不希望在示例中公开一些实体字段。是否可以在不修改现有java模型的情况下修改此示例?例如,是否可以在下面的示例中排除lastUpdate 是,可以使用jackson annotationsJsonIgnore忽略示例值中的lastUpdate import
lastUpdate
是,可以使用jackson annotations
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;
}
}
尝试添加
@JsonIgnore
也会将其从其他操作的响应中删除,这不是我想要实现的。我只是想隐藏它,以免招摇过市。如果您不希望它们的设置具有内聚性,那么响应和请求在您的体系结构中应该是独立的类。在field或getter上进行注释时不起作用-也会从模型中消失。这样,它的工作原理与Swagger的“隐藏”属性相同。