如何在 Swagger-UI“值”字段中仅显示必需的参数

Question

我有Post 方法。 Swagger-Ui 默认在JSON 中生成示例查询，所有fields 来自Class。

我想在默认情况下只显示非可选字段。

在Swagger-Ui Model 我清楚地看到：

x (integer, optional),
y (string), 

有些字段是可选的，有些则不是。

我怎样才能在Spring MVC Spring Boot app 中实现这一点？

我的 Swagger 配置：

@Configuration
@EnableSwagger2
public class SwaggerConfig
{
    @Bean
    public Docket api()
    {

        return new Docket(DocumentationType.SWAGGER_2).

                select().apis(RequestHandlerSelectors.any()).paths(PathSelectors.ant("/api/**")).build();

    }
}

@ApiModelProperty(hidden = true)

隐藏字段 - 但我不希望那样。 我只想让Swagger 在单击Model Schema 时仅基于非可选字段生成JSON。

Answer 1

这不是 Swagger UI 的功能，因此无法将其配置为按照您的要求行事。所以考虑修改源代码来做你在 swagger-ui 项目中要求的事情

Answer 2

用Jackson's @JsonIgnoreProperties 标记您的模型，例如

@JsonIgnoreProperties(value = {"field1", ...})
public class YourModel {

    private String field1;

    private String field2;

    //getters and setters here
}

进行测试，假设field1 是null

ObjectMapper objectMapper = new ObjectMapper();
YourModel model = new YourModel();

String strField1 = objectMapper.writeValueAsString(objectMapper);

assertThat(strField1, not(containsString("field1")));

见@JsonIgnoreProperties。