现代化设计
基于现代 Web 技术栈构建,采用响应式设计理念。提供清晰直观的界面布局,支持暗色/亮色主题切换,为开发者带来舒适的文档浏览体验。
告别传统 Swagger UI 的局限性,拥抱现代化的 API 文档体验。NextDoc4j 不仅仅是一个 UI 替换工具,更是为 Java 开发者量身定制的文档解决方案。
完全兼容 SpringDoc 和 OpenAPI 3 规范,无缝迁移现有项目
支持品牌化定制和主题配置,满足企业级项目需求
提供直观的 API 调试界面和便捷的参数测试功能
告别传统界面束缚,享受现代化的 API 文档浏览体验
📋 版本要求
NextDoc4j 1.4.0:统一 Boot 3 / 4 单套 Starter
推荐:Spring Boot 3.5.x 或 Spring Boot 4.x · JDK 17+
单体 nextdoc4j-spring-boot-starter,网关 nextdoc4j-gateway-spring-boot-starter,BOM nextdoc4j-bom
1.4.0:
nextdoc4j-bom只管理 NextDoc4j 自身版本;springdoc 由宿主引入(WebMvc / WebFlux 二选一)。
<dependency>
<groupId>top.nextdoc4j</groupId>
<artifactId>nextdoc4j-spring-boot-starter</artifactId>
<version>1.4.0</version>
</dependency>
<!-- 宿主自行引入 springdoc UI:WebMvc 用 webmvc-ui,WebFlux 用 webflux-ui -->
<!-- Boot 3 推荐 2.8.17;Boot 4 推荐 3.0.3(也可用 springdoc-openapi-bom 统一管理) -->
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version>2.8.17</version>
</dependency><!-- 放到 dependencyManagement > dependencies 中 -->
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-bom</artifactId>
<version>2.8.17</version><!-- Boot 4 请改为 3.0.3 -->
<type>pom</type>
<scope>import</scope>
</dependency>
<dependency>
<groupId>top.nextdoc4j</groupId>
<artifactId>nextdoc4j-bom</artifactId>
<version>1.4.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<!-- 放到 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>
<!-- WebFlux:springdoc-openapi-starter-webflux-ui -->
</dependency>网关场景
引入 nextdoc4j-gateway-spring-boot-starter(1.4.0),并自行加入对应 Spring Cloud Gateway(spring-cloud-starter-gateway-server-webflux / ...-webmvc)与 springdoc UI(springdoc-openapi-starter-webflux-ui / ...-webmvc-ui)。详见 快速开始 与 网关插件。
在 application.yml 或 application.properties 中添加配置:
nextdoc4j:
enabled: true # 是否启用 NextDoc4j,默认 false
# doc-path: /docs # 可选:自定义文档入口(默认 /doc.html)nextdoc4j.enabled=true
# nextdoc4j.doc-path=/docs启动应用后,在浏览器中访问:
http://localhost:端口/doc.html💡 提示
8080http://localhost:8080/doc.htmlnextdoc4j.doc-path,请使用对应路径访问/nextdoc/**

接口详情 与 在线调试 两个 Tab 快速切换