如何使用 Jersey 禁用 OpenAPI 规范中的 /application.wadl

Question

设置

我使用 来自 Initializr 的 Spring Boot 应用程序包含 Jersey 依赖项，并添加 io.swagger.core.v3:swagger-jaxrs2:2.1.13 作为附加依赖项。然后，我创建以下 ResourceConfig（为简洁起见，省略了注册其他资源类）：

@Component
public class JerseyConfig extends ResourceConfig {
    public JerseyConfig() {
        this.registerClasses(
                OpenApiResource.class
        );
    }
}

当我启动应用程序并在 http://localhost:8080/openapi.json 查看生成的 API 规范时，我发现两个路径

• ： >GET /application.wadl/{path} 和
• GET /application.wadl

在 Swagger UI 中，它看起来像这样：

当我向 WADL 端点发送请求时，我得到此设置中的 404 响应。我已经尝试使用此行禁用 WADL 功能，但规范仍然包含两个路径：

this.property(ServerProperties.WADL_FEATURE_DISABLE, true);

问题

如何正确禁用或隐藏 OpenAPI 规范中的这两个路径？

Answer 1

spring 文档不支持开箱即用的 jersey/JAX-RS。
您需要在 Jersey 资源配置中控制 openapi.json 生成逻辑。

OpenApiResource openApiResource = new OpenApiResource();
// change package name
openApiResource.setResourcePackages(Set.of("com.service.resource"));
// you can do a lot of configuration here
// https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties
register(openApiResource);

Answer 2

也许你可以尝试 packages-to-scan 属性

springdoc:
   packages-to-scan:
    - com.myapp.appName.controller