NextDoc4j

主题

SpringDoc · OpenAPI 3 · Boot 3 & 4 统一支持

重构 Java API 文档的
现代工作台与调试体验

专为 SpringDoc 打造的高效文档界面。单套 Starter 零学习成本替代传统 Swagger UI，集成多维接口查看、SSE 流式调试、Sa-Token 权限码与微服务网关聚合。

开始集成使用在线功能演示
JDK 17+Spring Boot 3.4.x / 4.xOpenAPI 3.1Version 1.4.1
SSE 流式调试
实时事件流 / 虚拟滚动
Sa-Token 权限码
原生注解自动识别联动
枚举智能释义
下拉单选与字典自动绑定
微服务网关聚合
WebFlux / WebMvc 自动路由
TS / Java 实体生成
一键生成 Request/Response
http://localhost:8080/doc.html
NextDoc4j 接口总览浅色界面NextDoc4j 接口总览深色界面

系统化探索核心架构能力

结构清晰、触手可及。点击左侧能力目录，查看 NextDoc4j 针对研发协作链路的针对性优化。

01

在线调试与 SSE 流

Path/Query/Header/Body 联动与流式事件响应

02

微服务网关聚合

Spring Cloud Gateway 路由与文档自动发现

03

Sa-Token 权限码提取

原生识别方法注解与鉴权参数透传

04

枚举字典与多维导出

字段含义下拉补全与 Markdown / OpenAPI 导出

DEBUG & SSEOpenAPI 3.1

全能型接口调试与 SSE 流式事件支持

重新组织调试工作台，参数编辑、动态 Header 注入、响应状态码分段展示与原请求回显同屏完成。1.4.0 深度支持 Server-Sent Events 流式事件，实时查看并可一键终止。

多参数联动校验
支持 Path、Query、Cookie、Form-Data 与 JSON Body 混合输入
SSE 流式事件虚拟滚动
高效渲染 AI / 消息推送流式数据，支持随时暂停和终止
阅读该特性的详细使用指南

单 Starter 适配 Boot 3 & 4

1.4.0 起统一单套坐标，无论在 Spring Boot 3.4.x 还是 Spring Boot 4 环境下均可无缝引入，无需为不同版本切换 artifactId。

nextdoc4j-bomZero-Migration

企业级品牌与主题定制

基于 Vben 5 设计标准，支持自定义 Logo、系统标题、主色调、菜单展示模式与文档入口路径，与企业产品视觉体系统一。

CSS VariablesBrand Theme

安全鉴权与全局配置

支持简单文档密码拦截、全局 Token 注入与调试缓存开关控制。敏感环境轻松锁定，避免未授权调试。

Auth InterceptorGlobal Params

最简依赖引入与配置

支持单体 WebMvc / WebFlux、网关 WebFlux / WebMvc 及 BOM 统一版本管理，几行配置即可替换传统 Swagger UI。

单体服务 · Servlet 栈配合 spring-boot-starter-web · 统一 Starter 适配 Boot 3.4.x / 4.x
<!-- NextDoc4j 核心 Starter (Boot 3.4.x / 4.x 统一坐标) -->
<dependency>
    <groupId>top.nextdoc4j</groupId>
    <artifactId>nextdoc4j-spring-boot-starter</artifactId>
    <version>1.4.1</version>
</dependency>

<!-- 宿主自行引入 SpringDoc WebMvc UI -->
<!-- Boot 3.4.x 推荐 2.8.17；Boot 4.x 请改为 3.0.3 -->
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
    <version>2.8.17</version>
</dependency>
<!-- NextDoc4j 核心 Starter (Boot 3.4.x / 4.x 统一坐标) -->
<dependency>
    <groupId>top.nextdoc4j</groupId>
    <artifactId>nextdoc4j-spring-boot-starter</artifactId>
    <version>1.4.1</version>
</dependency>

<!-- 宿主自行引入 SpringDoc WebFlux UI -->
<!-- Boot 3.4.x 推荐 2.8.17；Boot 4.x 请改为 3.0.3 -->
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webflux-ui</artifactId>
    <version>2.8.17</version>
</dependency>
<!-- NextDoc4j 网关聚合 Starter (Boot 3.4.x / 4.x 统一坐标) -->
<dependency>
    <groupId>top.nextdoc4j</groupId>
    <artifactId>nextdoc4j-gateway-spring-boot-starter</artifactId>
    <version>1.4.1</version>
</dependency>

<!-- Spring Cloud Gateway 响应式网关运行时 (WebFlux) -->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-gateway-server-webflux</artifactId>
</dependency>

<!-- 宿主引入 SpringDoc WebFlux UI (Boot 3.4.x: 2.8.17 / Boot 4: 3.0.3) -->
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webflux-ui</artifactId>
    <version>2.8.17</version>
</dependency>
<!-- NextDoc4j 网关聚合 Starter (Boot 3.4.x / 4.x 统一坐标) -->
<dependency>
    <groupId>top.nextdoc4j</groupId>
    <artifactId>nextdoc4j-gateway-spring-boot-starter</artifactId>
    <version>1.4.1</version>
</dependency>

<!-- Spring Cloud Gateway 阻塞式网关运行时 (WebMvc) -->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-gateway-server-webmvc</artifactId>
</dependency>

<!-- 宿主引入 SpringDoc WebMvc UI (Boot 3.4.x: 2.8.17 / Boot 4: 3.0.3) -->
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
    <version>2.8.17</version>
</dependency>
<!-- 1. 放入 dependencyManagement 中统一管理 NextDoc4j 与 SpringDoc 版本 -->
<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>top.nextdoc4j</groupId>
            <artifactId>nextdoc4j-bom</artifactId>
            <version>1.4.1</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
        <!-- SpringDoc BOM: Boot 3.4.x 填 2.8.17；Boot 4 填 3.0.3 -->
        <dependency>
            <groupId>org.springdoc</groupId>
            <artifactId>springdoc-openapi-bom</artifactId>
            <version>2.8.17</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

<!-- 2. 在 dependencies 中直接引入（无需填写 version 版本号） -->
<dependencies>
    <dependency>
        <groupId>top.nextdoc4j</groupId>
        <artifactId>nextdoc4j-spring-boot-starter</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springdoc</groupId>
        <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
    </dependency>
</dependencies>
nextdoc4j:
  enabled: true                    # 是否启用 NextDoc4j 文档工作台（默认 false）
  doc-path: /doc.html              # 自定义文档入口路径（默认 /doc.html）
  gateway:
    auto-discovery: true           # 网关场景：开启子微服务 OpenAPI 文档自动发现与聚合
    routes-reload-interval: 30s    # 网关场景：动态路由探测刷新间隔

技术特性对比概览

维度指标
NextDoc4j (v1.4.1)
传统 Swagger UI
Boot 3 / 4 适配
单套坐标统一支持
依赖拆分多套坐标
SSE 流式调试
支持事件流渲染与中止
仅单次响应缓冲
微服务网关聚合
自动推导与 StripPrefix
需手动编码转发配置
权限码注解识别
原生解析 Sa-Token 注解
无原生权限注解联动
视觉与主题体系
Vben 5 规范 / 浅深双模
陈旧单列卡顿布局

开源社区与快速链接

选择您喜爱的代码托管平台 Star 支持我们，或快速导航至相关文档。

Gitee 码云
国内主仓

官方主代码仓库，提供国内极速拉取与发行版同步下载。

前往 Gitee Star
GitHub
全球镜像

面向全球开发者的开源协作阵地，欢迎提交 Issue 缺陷与 PR。

前往 GitHub Star
GitCode
GitCode
CSDN 社区

CSDN 开发者生态代码托管平台，支持开发者一键同步与交流。

前往 GitCode Star

指南文档

插件生态

社区支持

代码仓库