Question

我使用springfox-swagger2和springfox-swagger-ui版本2.5.0依赖项来生成我的JSON API，并使用swagger-ui来显示JSON消息。

目前swagger ui显示我的JSON模型，所有字段都是可选的。如何指定所需的某些字段。我是否需要在POJO中注释任何字段以声明它是必需的。我没有使用任何招摇的注释，依靠springfox从我的POJO生成JSON。

感谢

Answer 1

您必须使用＆＃39; required＆＃39; @ApiModelProperty注释的属性

public class LoginResponse {

    @ApiModelProperty(value="User's last name", required = true)
    String firstName;

    @ApiModelProperty(value="User's first name", required = true)
    String lastName;

    public LoginResponse(String firstName, String lastName) {
        this.firstName= firstName;
        this.deviceSecret = lastName;
    }

}

Answer 2

另一个选择：

public ResponseEntity<XXX> getXXX(
        @RequestParam(value="id", defaultValue = "1234") @ApiParam(value="Some description of id", required = true) String id,
        @RequestParam(value="anotherField", defaultValue = "AR") @ApiParam(value="another Field", required = true) String anotherField) {

在ApiParam批注中使用required = true或false对我有用。

如何使swagger-ui根据需要在JSON中显示某些字段（使用springfox-swagger2＆amp; ui）

2 个答案: