如何为 swagger-ui 指示对象的 required 属性

Question

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

如何更新它以显示 'required' 或星标？

我尝试使用 @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 在我们的应用程序中。

截图在link下方

Swagger-required-properties

Answer 1

swagger-ui.js javascript 文件可以如下更新，这样 'required' 字符串可以出现在指定属性的模型部分。

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

如何为 swagger-ui 指示对象的 required 属性

How to indicate required properties for an object for swagger-ui

java

swagger

swagger-ui