讲师中心 微信公众号
AI工具推荐 视频效率加速

如何在多 Servlet 环境下正确生成 Swagger API 文档路径

胖敏酱_1795

胖敏酱_1795

发布时间:2026-07-11 15:39:54

|

243人浏览过

|

来源于php中文网

原创

本文解决 Jersey 多 @ApplicationPath 应用共存时 Swagger 无法识别真实业务路径的问题,核心方案是弃用多个 @ApplicationPath,改用统一根路径 + @Path 显式声明完整资源路径,确保 OpenAPI 文档准确反映实际 HTTP 接口地址。

本文解决 jersey 多 `@applicationpath` 应用共存时 swagger 无法识别真实业务路径的问题,核心方案是弃用多个 `@applicationpath`,改用统一根路径 + `@path` 显式声明完整资源路径,确保 openapi 文档准确反映实际 http 接口地址。

在基于 Jersey 和 Swagger(如 swagger-jaxrs2)构建的微服务或多模块 REST API 项目中,开发者常尝试通过多个 @ApplicationPath(如 /endpoint_1、/endpoint_2)隔离不同功能模块。然而,Swagger 的 OpenAPI 扫描机制仅作用于单个 ResourceConfig 实例的注册上下文,且不感知 @ApplicationPath 的运行时路由前缀——它只解析 @Path 注解声明的相对路径,并默认将其挂载到当前 ResourceConfig 所绑定的 Servlet 上下文根路径下。

因此,当您定义:

@ApplicationPath("/endpoint_1")
public class Endpoint1 extends ResourceConfig { /* ... */ }

@Path("/path1")
public class SomeObject1 { } // 实际访问路径:/endpoint_1/path1

Swagger 并不会自动将 /path1 补全为 /endpoint_1/path1;相反,若您单独启动一个仅用于 Swagger 的 @ApplicationPath("/swagger") 配置类,它只会扫描自身注册的资源(通常为空),或错误地将所有 @Path 视为相对于 /swagger,导致生成 /swagger/path1 这类无效文档路径。

✅ 正确做法:移除所有 @ApplicationPath,统一使用单一 ResourceConfig(或确保 Swagger 扫描覆盖全部资源),并通过 @Path 显式声明完整业务路径:

// 统一入口配置(推荐使用一个 ResourceConfig)
@ApplicationPath("/")
public class ApiConfig extends ResourceConfig {
    public ApiConfig() {
        // 注册全部资源类
        register(SomeObject1.class);
        register(SomeObject2.class);

        // 注册 Swagger OpenAPI 资源
        OpenApiResource openApiResource = new OpenApiResource();
        SwaggerConfiguration config = new SwaggerConfiguration()
            .openAPI(new OpenAPI())
            .prettyPrint(true);
        openApiResource.setOpenApiConfiguration(config);
        register(openApiResource);
    }
}

// 资源类中显式写出完整路径
@Path("/endpoint_1/path1")
public class SomeObject1 {
    @GET
    @Produces(MediaType.TEXT_PLAIN)
    public String getEndpoint1() {
        return "From endpoint_1";
    }
}

@Path("/endpoint_2/path2")
public class SomeObject2 {
    @GET
    @Produces(MediaType.TEXT_PLAIN)
    public String getEndpoint2() {
        return "From endpoint_2";
    }
}

这样,Swagger 扫描到的 @Path 值即为真实可访问路径,生成的 OpenAPI 文档中 paths 字段将准确显示:

paths:
  /endpoint_1/path1:
    get: { ... }
  /endpoint_2/path2:
    get: { ... }

? 注意事项:

  • 若必须物理隔离(如部署为独立 WAR),请改用 Servlet 容器级路径映射(如 Tomcat 的 context.xml 或 Spring Boot 的 server.servlet.context-path),而非 @ApplicationPath;
  • 使用 swagger-jaxrs2 时,确保 OpenApiResource 与业务资源注册在同一个 ResourceConfig 实例中;
  • 如需动态分组,可在 OpenAPI 对象中通过 addTags() 和 setServers() 手动组织逻辑分组,而非依赖路径前缀。

最终,Swagger UI 将正确展示 http://host:port/endpoint_1/path1 等真实端点,实现文档与运行时行为的一致性——这是 API 可靠性与协作效率的基础保障。

热门AI工具

更多
DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

9557

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

6722

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

5952

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1044

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

868

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

1236

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2509

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

19851

2023.08.03

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

20

2026.09.30

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
apipost极速入门
apipost极速入门

共6课时 | 0.6万人学习

Runway官方API文档
Runway官方API文档

共0课时 | 0人学习

Vidu 快速入门手册
Vidu 快速入门手册

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn