忽略 Springdoc openapi 3 @Schema 示例
Springdoc openapi 3 @Schema example ignored
@Schema 示例在一个 class 属性 上被 springdoc Openapi 忽略,但在同一个 class 上处理其他 属性。
已添加
@Schema(type = "integer", format = "int64", example = "1560868939063") private Instant date;
在 Class 的字段上。
访问 /v3/api-docs 端点我可以看到该示例被完全忽略,它显示:
"MyClass":{"type":"object","properties":{"date":{"type":"integer","format":"int64"},...
编辑:
似乎被忽略了,因为Field的类型是java.time.Instant,意思是实际的java class 属性类型,而不是“类型”属性在@Schema 中。在字符串类型的字段上,它可以工作并显示示例。
使用 spring-boot 2.5:
api "org.springdoc:springdoc-openapi-ui:1.6.4"
api "org.springdoc:springdoc-openapi-data-rest:1.6.4"
api "org.springdoc:springdoc-openapi-security:1.6.4"
我的基础配置项目中有一个配置似乎覆盖了架构。虽然我不认为这是它应该的工作方式,但如果我删除它,它就可以工作。
SpringDocUtils.getConfig().replaceWithClass(Instant.class, Long.class);
@Schema 示例在一个 class 属性 上被 springdoc Openapi 忽略,但在同一个 class 上处理其他 属性。 已添加
@Schema(type = "integer", format = "int64", example = "1560868939063") private Instant date;
在 Class 的字段上。
访问 /v3/api-docs 端点我可以看到该示例被完全忽略,它显示:
"MyClass":{"type":"object","properties":{"date":{"type":"integer","format":"int64"},...
编辑: 似乎被忽略了,因为Field的类型是java.time.Instant,意思是实际的java class 属性类型,而不是“类型”属性在@Schema 中。在字符串类型的字段上,它可以工作并显示示例。
使用 spring-boot 2.5:
api "org.springdoc:springdoc-openapi-ui:1.6.4"
api "org.springdoc:springdoc-openapi-data-rest:1.6.4"
api "org.springdoc:springdoc-openapi-security:1.6.4"
我的基础配置项目中有一个配置似乎覆盖了架构。虽然我不认为这是它应该的工作方式,但如果我删除它,它就可以工作。
SpringDocUtils.getConfig().replaceWithClass(Instant.class, Long.class);