我有一个简单的CXF-REST应用程序,对于其中一个服务,我有一个对象作为输入。其中一个参数对于成功验证是必需的,但是,swagger-ui 显示可选或空。
如何更新它以显示"必需"或星号标记?
我尝试使用@ApiModelProperty(required=true)
,但没有运气。
@Path("/user")
@Api(value = "/user", description = "User Service")
public interface UserService {
@POST
@Path("/saveUser")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
@ApiOperation(value = "Save User details to backend", response = User.class)
public User saveUser(User user);
}
@ApiModel(description = "User")
@XmlRootElement
public class User {
@ApiModelProperty(value = "", required = true)
private String name;
private Integer age;
//getters and setters
}
我们使用swagger-annotations_2.10-1.3.0.jar
, swagger-core_2.10-1.3.0.jar
, swagger-jaxrs_2.10-1.3.0.jar
在我们的应用程序中。
屏幕截图在下面的链接中
招摇所需的属性
swagger-ui.js javascript 文件可以按如下方式更新,以便"必需"字符串可以出现在指定属性的模型部分中。
if(!propertyIsRequired) {
html += ', <span class="propOptKey">optional</span>';
} else {
html += ', <span class="propOptKey">required</span>';
}