java - 如何在 sprinddoc 中添加一个操作未引用的类？

Question

我正在使用 springdoc与 spring-boot主要用注解配置。

我想公开一个未被任何服务引用的特定类模式。可以这样做吗？

在伪代码中，我实际上是在尝试这样做:

GroupedOpenAPI.parseAndAddClass(Class<?> clazz);

或

GroupedOpenAPI.scan("my.models.package");

=== 更新 ===

我设法使用 ModelConverters.getInstance().readAll(MyClass.class); 解析架构

然后尝试将其添加为 OpenApiCustomiser ，但它在 UI 中仍然不可见。

Answer 1

在 SpringDoc 中，可以使用 OpenApiCustomiser

将不相关的类添加到生成的规范中

@Bean
public OpenApiCustomiser schemaCustomiser() {
    ResolvedSchema resolvedSchema = ModelConverters.getInstance()
            .resolveAsResolvedSchema(new AnnotatedType(MyClass.class));
    return openApi -> openApi
            .schema(resolvedSchema.schema.getName(), resolvedSchema.schema);
}

但需要小心，因为如果您的附加模型没有在任何 API 中引用，默认情况下 SpringDoc 会自动删除每个损坏的引用定义。

要禁用此默认行为，您需要使用以下配置属性:

springdoc.remove-broken-reference-definitions=false