Swagger UI 在使用 ZoneId 和 jackson-datatype-jsr310 时显示嵌套模型对象

Question

我正在使用 Spring、springfox、Jackson 开发一个 REST API，我的模型类包含一个 ZoneId 作为属性：

@JsonProperty
private ZoneId timeZone;

我在依赖项中包含了 jackson-datatype-jsr310 版本 2.9.0.pr4，因此它可以按预期进行序列化和反序列化。但是我的 swagger-ui 现在显示了很多模型对象，例如 ZoneId、ZoneOffset、ZoneOffsetTransition 等，这非常令人困惑，因为区域 ID 被序列化为简单字符串。生成的 API 规范中的情况相同。 如何防止 swagger 暴露这些（未使用的）模型对象？

Answer 1

您可以尝试将@ApiModelProperty 设置为dataType 为string：

@JsonProperty
@ApiModelProperty(dataType = "string")
private ZoneId timeZone;

如果dataType 被忽略，您可以使用Docket：

@Bean
public Docket configureDocket() {
    return new Docket(DocumentationType.SWAGGER_2)
            .directModelSubstitute(ZoneId .class, String.class);
}