Question

我有一个简单的CXF-REST应用程序，对于其中一个服务'，我有一个对象作为输入。其中一个参数对于成功验证是必需的，但是，swagger-ui显示可选或空。

如何更新它以显示“必需”或星号？

我尝试使用@ApiModelProperty（必需= 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，招摇，core_2.10-1.3.0.jar， swagger-jaxrs_2.10-1.3.0.jar在我们的申请中。

SCREEENSHOT是BElow链接

Swagger-required-properties

Answer 1

swagger-ui.js javascript文件可以更新如下，以便＆＃39;要求＆＃39; string可以出现在指定属性的模型部分中。

  if(!propertyIsRequired) {
       html += ', <span class="propOptKey">optional</span>';
  } else {
       html += ', <span class="propOptKey">required</span>';
  }

如何为swagger-ui

1 个答案: