NextDoc4j

主题

NextDoc4j 概述与技术全景 ​

NextDoc4j 是面向 SpringDoc 和 OpenAPI 3 的现代化接口文档与在线调试工作台，以单套 Starter 统一适配 Spring Boot 3.4.x 与 4.x，全方位重构研发调试与协作体验。

Version 1.4.1Spring Boot 3.4.x / 4.xSpringDoc 2.8 / 3.xOpenAPI 3.1JDK 17+Vue 3.5.xTypeScript 5.8.xVite 6.xElement Plus 2.10.xVben 5 Standard

什么是 NextDoc4j？ ​

NextDoc4j 是一个基于现代 Web 技术栈深度重构的 Java API 文档与在线调试工作台。它专为 SpringDoc 和 OpenAPI 3 生态量身定制，旨在彻底打破传统 Swagger UI 陈旧、卡顿、交互不便的固有局限。

从 1.4.0 版本 起，NextDoc4j 实现了单套 Starter 坐标对 Spring Boot 3.4.x 与 Spring Boot 4.x 的无缝统一支持，并在单体 WebMvc / WebFlux 与 Spring Cloud Gateway 微服务网关场景中提供全功能开箱即用能力。

诞生背景与设计理念 ​

NextDoc4j 的诞生深深植根于开源生态的优秀实践，站在巨人的肩膀上不断演进与探索：

K
灵感源泉：Knife4j

深受 Knife4j 开源项目的启发。在长期使用中我们深刻体会到优秀文档工具对于研发效能的重要性，并在 OpenAPI 3 与现代 Web 潮流下进一步追求更极致的界面设计与交互体验。

V
视觉规范：Vben Admin 5

前端基于业界广受好评的 Vben Admin 5 企业级框架设计规范构建，采用 Vue 3.5、TypeScript 5.8 与 Vite 6，提供专业的组件体系、主题配置以及极佳的响应式浏览体验。

核心特性概览 ​

NextDoc4j 针对日常研发、接口调试与团队交付链路进行了系统性强化：

现代化企业级设计

  • 双模主题支持原生深浅色模式一键平滑切换
  • 响应布局深度适配宽屏显示器与移动端设备
  • 极简视觉规范化信息层级与交互视窗动效

全能接口调试工作台

  • 参数联动支持 Path、Query、Header 与 Body 校验
  • 流式调试实时接收并渲染 SSE 事件流与中止
  • 响应回显状态码、原始请求与多响应同屏比对

微服务网关聚合

  • 自动发现单 Starter 自动聚合微服务集群接口
  • 路由重写智能识别 StripPrefix 过滤器与路径映射
  • 全局检索网关统一控制台跨服务极速模糊搜索

权限码提取与品牌定制

  • 权限解析无侵入识别 Sa-Token 权限校验注解
  • 品牌定制自定义系统 Logo、主题色与文档路径
  • 离线归档一键导出 Markdown、HTML 与 OpenAPI

技术架构全景 ​

NextDoc4j 采用前后端高内聚低耦合的现代化架构设计：

前端工作台架构

  • 核心框架Vue 3.5
  • 构建工具Vite 6
  • 类型体系TypeScript 5.8
  • UI 组件库Element Plus 2.10
  • 状态管理Pinia 3
  • 设计标准Vben Admin 5

后端 Starter 架构

  • 运行环境JDK 17+
  • 核心框架Spring Boot 3.4.x / 4.x
  • 规范标准OpenAPI 3.1
  • 引擎基座SpringDoc 2.8 / 3.x
  • 依赖管理nextdoc4j-bom
  • 分发体系Maven Central

网关与扩展生态

  • 响应式网关SCG WebFlux
  • 阻塞式网关SCG WebMvc
  • 权限插件Sa-Token 插件
  • 枚举插件Enum 字典增强
  • 安全拦截简单认证插件
  • 离线归档MD / HTML 导出

工作台界面预览 ​

NextDoc4j 提供清晰的双栏工作台布局与沉浸式调试体验：

http://localhost:8080/doc.html
NextDoc4j 工作台预览

开源社区与支持 ​

NextDoc4j 遵循开源开放精神，欢迎前往您喜爱的代码托管平台 Star 或 Fork 共同建设：

Gitee 码云
国内主仓

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

前往 Gitee Star
GitHub
全球镜像

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

前往 GitHub Star
GitCode
GitCode
CSDN 社区

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

前往 GitCode Star
加入技术交流与社群支持
与核心维护团队即时交流集成心得，或提交 Bug / Feature 需求
加入交流群贡献指南常见问题 FAQ

开源协议与致谢 ​

NextDoc4j 基于 Apache License 2.0 协议开源。感谢以下优秀的开源项目与社区生态：

  • Knife4j — 优秀的 Swagger 增强工具，为我们提供了宝贵的研发设计灵感。
  • Vben Admin — 企业级管理系统框架，为前端 UI 奠定了坚实的技术底座。
  • SpringDoc — 优秀的 Spring Boot OpenAPI 3 规范集成底座。
  • Swagger UI — 经典的 API 交互式文档先行者。
  • Vue.js & Element Plus — 现代化的前端响应式框架与组件生态。