在 Swagger 上向下钻取模型对象

Question

我的应用程序是一个Rest的api，它与Swagger和OpenAPI集成。我已经使用OpenAPI YAML文件生成了所有Java存根，一切都正常。但是当我尝试在Swagger上钻取模型对象时，它无法找到一些对象，尽管项目的一部分编译良好。

如下面的屏幕截图所示，向下钻取无法找到配置对象。

有什么解决办法吗？

编辑:

我有一个 restful 网络服务，我使用 openapi 生成器插件从 YAML 文件生成所有 java 存根 [数据传输对象]。该插件自动生成一个类OpenAPIDocumentationConfig，以下是该类的详细信息。完成此设置后，将在 Swagger UI 中自动生成模型。还想补充一点，我正在使用 OpenAPI 3.0，但我需要将对象定义拆分为多个文件。所以我使用定义来指代它们，因为我不相信组件架构可以拆分为多个文件。

@Configuration
@EnableSwagger2
public class OpenAPIDocumentationConfig {

ApiInfo apiInfo() {
    return new ApiInfoBuilder()
        .title("ABC Service")
        .description("ABC Service")
        .license("")
        .licenseUrl("http://unlicense.org")
        .termsOfServiceUrl("")
        .version("1.0.0")
        .contact(new Contact("","", "[e-mail]"))
        .build();
}

@Bean
public Docket customImplementation(ServletContext servletContext, @Value("${openapi.studioVALService.base-path:}") String basePath) {
    return new Docket(DocumentationType.SWAGGER_2)
            .select()
                .apis(RequestHandlerSelectors.basePackage("com.x.y.z"))
                .build()
            .pathProvider(new BasePathAwareRelativePathProvider(servletContext, basePath))
            .directModelSubstitute(java.time.LocalDate.class, java.sql.Date.class)
            .directModelSubstitute(java.time.OffsetDateTime.class, java.util.Date.class)
            .apiInfo(apiInfo());
}

class BasePathAwareRelativePathProvider extends RelativePathProvider {
    private String basePath;

    public BasePathAwareRelativePathProvider(ServletContext servletContext, String basePath) {
        super(servletContext);
        this.basePath = basePath;
    }

    @Override
    protected String applicationPath() {
        return  Paths.removeAdjacentForwardSlashes(UriComponentsBuilder.fromPath(super.applicationPath()).path(basePath).build().toString());
    }

    @Override
    public String getOperationPath(String operationPath) {
        UriComponentsBuilder uriComponentsBuilder = UriComponentsBuilder.fromPath("/");
        return Paths.removeAdjacentForwardSlashes(
                uriComponentsBuilder.path(operationPath.replaceFirst("^" + basePath, "")).build().toString());
    }
}

}

编辑2：

我将所有定义都移到了组件和架构中，但它们仍然被拆分为多个文件，并且引用了跨文件的组件，但仍然收到相同的错误。

Answer 1

如果您使用的是 OpenAPI 3，则应将要重用的架构放在组件中。要引用它，您必须使用如下引用：

$ref: "#/components/schemas/EquityOptionConfigurationDO"