版本摘要:本版本为稳定性修复版本,重点完善多 RequestMappingHandlerMapping 环境下的安全插件兼容性,并修复复杂数据模型示例展示异常。
修复树结构示例嵌套过深的问题,限制自引用结构的展开层级并收束叶子节点。
修复循环引用类型显示为 array<ref> 的问题,改为展示实际组件类型名称。
修复非字符串类型使用空字符串默认值时,请求体或子节点示例为空的问题。
版本摘要:NextDoc4j 架构重大升级版本!统一 Spring Boot 3 与 Boot 4 为单套 Maven 坐标,深度支持 SSE 流式事件调试与网关 StripPrefix 智能路由推导。
兼容性说明 · Maven 坐标统一化(重要迁移须知)
从 1.4.0 开始,废弃原先区分 Boot 3 / Boot 4 的多套坐标命名,统一合并为单套标准坐标。
旧版坐标(1.3.x 废弃)nextdoc4j-springboot3-starter
新版统一坐标(1.4.0+ 推荐)nextdoc4j-spring-boot-starter
统一 Boot 3 / 4 为单套坐标:nextdoc4j-spring-boot-starter、nextdoc4j-gateway-spring-boot-starter;新增薄 BOM nextdoc4j-bom 与 Jackson 2/3 适配层。
支持 nextdoc4j.doc-path 自定义文档入口(默认 /doc.html);登录页支持浅色 / 深色主题切换。
网关透传路由 filters,按 StripPrefix 解析文档路径;改写子服务 swagger-config 分组 URL。
新增接口分组概览;详情支持 oneOf/anyOf 分段选择、响应状态码切换、Body 枚举与类型折叠。
在线调试支持 SSE 实时展示 / 终止与 Content-Type 自动补全;响应体支持 XML 与多格式高亮。
导出增强响应示例生成;优化 AI 复制与调试面板体验。
Spring Boot 3:3.5.16
Spring Cloud(Spring Boot 3):2025.0.3
Springdoc:2.8.17(Boot 3;Boot 4 请用 springdoc 3.x)
Sa-Token:1.45.0
移除:Hutool
swagger-core-jakarta:改由 springdoc 传递管理
Spring Boot 33.5.16
Spring Cloud2025.0.3
Springdoc2.8.17 / 3.x
Sa-Token1.45.0
Hutool移除
swagger-core传递管理
版本摘要:本版本聚焦开源社区接入与构建发布链路稳定性,完善社区入口并修正多模块发布版本问题。
Spring Boot 3 升级:3.5.14 -> 3.5.16
Spring Cloud(Spring Boot 3)升级:2025.0.2 -> 2025.0.3
Spring Boot 4 升级:4.0.6 -> 4.1.0
Spring Cloud(Spring Boot 4)升级:2025.1.1 -> 2025.1.2
Hutool 升级:5.8.44 -> 5.8.46
Swagger Core 升级:2.2.47 -> 2.2.51
Spotless Maven Plugin 升级:2.43.0 -> 3.7.0
Flatten Maven Plugin 升级:1.6.0 -> 1.7.3
Maven Source Plugin 升级:3.3.1 -> 3.4.0
Maven Javadoc Plugin 升级:3.11.2 -> 3.12.0
Maven GPG Plugin 升级:3.1.0 -> 3.2.8
Central Publishing Maven Plugin 升级:0.8.0 -> 0.11.0
版本摘要:本版本集中完善在线调试状态记忆、文本草稿恢复与复杂数据结构展示,提升前端交互稳定性。
新增接口文档调试面板状态记忆能力,可在页面切换或重新进入后自动恢复调试视图状态。
新增请求体文本草稿缓存与恢复能力,支持 json、raw、xml 等多种文本类型的独立保存与切换恢复。
新增调试面板加载中与空状态提示,提升接口文档页的状态反馈体验。
优化标签页关闭逻辑,关闭全部标签页时优先保留首页,提升操作一致性。
优化路由兜底处理,访问无效页面或异常跳转时可自动回退到可用页面。
优化接口文档页调试状态同步时机,减少状态覆盖、显示延迟和异常闪动问题。
优化请求参数、请求体和调试状态的数据渲染机制,通过唯一行键提升表格更新稳定性。
优化 JSON 示例展示结构与样式,长内容场景下支持横向滚动,提升可读性。
优化字段说明与注释区域布局,改善复杂数据结构下的展示效果。
修复请求体草稿在类型切换、页面隐藏及只读视图场景下可能丢失或异常刷新的问题。
修复 Query 参数编辑过程中因行键不稳定导致的光标失焦问题。
修复关闭标签页后可能进入无效路由、回退异常或目标页面不存在的问题。
修复 JSON 示例在长内容场景下出现越界、挤压或显示不完整的问题。
版本摘要:本版本完成网关聚合、接口详情工作台、在线调试、导出和全局检索等核心能力扩展,是一次面向完整研发链路的重要升级。
新增 Spring Cloud Gateway WebMvc 聚合文档支持,提供独立的 gateway-webmvc-starter、路由定位器、响应重写过滤器与自动配置桥接,使 Servlet / WebMvc 网关也可完成文档自动发现、聚合与安全方案注入。
为 WebFlux / WebMvc 网关统一引入中立路由模型与定位器接口,新增 nextdoc4j-plugin-gateway-core、NextDoc4jGatewayRouteDefinitionLocator、GatewayRouteDefinition / GatewayPredicateDefinition,支持跨运行时复用路由发现与元数据解析逻辑。
新增功能 · 后端(Starter 与模块体系)
2 项新增新增高级在线调试能力,支持 Path / Query / Header / Cookie / Body 联动编辑、请求缓存、Content-Type 切换、form-data / file 上传、复制 BaseURL / Path,以及二进制、图片 / Base64 响应处理。
新增文档导出中心,支持全局参数管理、自定义导出范围、聚合服务导出,以及 Markdown / HTML / OpenAPI JSON / Docx / PDF 多格式导出。
重构 Spring Boot 3/4 版本层父 POM 与模块层级,统一公共依赖声明并梳理 Starter 边界,降低不同运行时之间的耦合与重复维护成本。
优化网关自动发现链路:统一自动配置与手动配置的文档入口模型,增强 metadata、Path Predicate、URI 与服务 context-path 的组合解析能力,服务名、文档路径与 serviceId 提取更稳定。
优化自动配置装配边界,WebFlux / WebMvc 按运行时独立生效,网关聚合、基础认证、资源过滤和扩展配置的 Bean 组合更清晰。
接口详情页整体重构,参数区域、自适应布局、折叠交互、Schema 切换和调试联动体验明显增强。
优化 JSON Viewer 与大响应渲染性能,增加分块渲染与滚动位置保留,长文档和大 JSON 的可用性更好。
持续增强文档导出页,补齐权限 / 鉴权信息、响应示例、排序规则和预览性能,导出预览加入虚拟滚动。
持续优化在线调试体验,请求参数表、代码格式、响应处理逻辑、缓存恢复和调试区交互更稳定。
菜单、侧边栏、全局搜索和路由生成逻辑做了多轮性能与交互优化,搜索匹配和文档定位更自然。
工程侧补充系统暗黑模式跟随、首页版本号从后端 x-nextdoc4j.version 读取、统一 OpenAPI 与在线调试超时,并移除了前端定时检查更新 / ws 相关配置。
修复 Spring Cloud Gateway MVC 场景下原先仅覆盖 WebFlux 的能力缺口,补齐 Servlet / WebMvc 网关场景下的路由读取、文档聚合与响应改写链路。
修复不同网关实现与 Spring Boot 3/4 Starter 中通用类分散、装配边界混杂的问题,避免错误模块被引入或重复维护。
修复路由元数据解析的兼容性边界,增强 routesMap、空路由 / 空谓词、嵌套 nextdoc4j metadata、缺省 URI 与服务名回退等场景下的兜底处理。
修复在线调试 URL 解析里 pathAndSearch 可能为空的问题,以及 form-data 文件上传展示、悬浮提示和内容类型处理异常。
修复接口详情页切换标签时的展开闪动、状态重置、嵌套参数必填识别错误、空 JSON 结构展示异常。
修复 Schema 解析边界问题,包括数组 items 的 $ref 解析、枚举值为 0 被过滤、多内容类型响应渲染异常等。
修复聚合模式下错误命中展示、聚合在线测试适配、全局认证折叠样式、图标响应式解析和重复主题配置问题。
修复偏好设置中的水印开关不生效,并同步优化相关文案来源和显示逻辑。
Spring Boot 3 升级:3.5.11 -> 3.5.13
Spring Cloud(Spring Boot 3)升级:2025.0.0 -> 2025.0.2
Spring Boot 4 升级:4.0.3 -> 4.0.5
Springdoc 升级:2.8.16 -> 2.8.17(Spring Boot 3)
Springdoc(Spring Boot 4)升级:3.0.2 -> 3.0.3
Swagger 升级:2.2.45 -> 2.2.47
Sa-Token 升级:1.44.0 -> 1.45.0(Spring Boot 3)
版本摘要:本版本围绕模块体系、网关聚合、全局搜索、导出和在线调试缓存完成大范围能力补齐,并同步优化配置与安全边界。
支持实体菜单描述悬浮提示。
支持根据系统暗色模式自动切换主题。
新增在线调试请求缓存能力。
统一并精简配置属性与自动配置模型:使用 NextDoc4jPropertiesMetadata 替换旧配置属性,网关配置改用 @ConfigurationProperties。
重构网关与安全模块边界,移除冗余默认 OpenAPI Bean/网关核心依赖,安全包路径由 security.core 迁移至 security.schemes。
提取并复用基础工具能力(基础认证、资源处理、路径匹配等),并优化异常处理与默认元数据赋值。
优化菜单图标处理、全局认证路由逻辑、聚合路由初始化与服务数据获取流程。
优化导出页面布局、参数显示、筛选逻辑与权限描述。
重构 Markdown 目录组件并优化样式与交互。
优化文件上传状态管理、必填字段处理与请求体变更事件通知机制。
统一 POM 版本并移除 nextdoc4j-dependencies 模块,修复构建结构问题。
修复 Spring Boot 4 场景下 Jackson 导入路径问题,兼容 springdoc/swagger 传入 JavaType。
修复网关安全方案处理与路径模式转换逻辑(增强 Ant 风格匹配)。
通过 @ConditionalOnMissingBean 避免安全配置属性重复注入。
修复全局检索方法标签样式和布局显示问题。
修正上传文件类型断言顺序。
修复聚合模式下错误命中展示问题。
Spring Boot 3 升级:3.5.7 -> 3.5.11
Spring Boot 4 升级:4.0.3
Springdoc 升级:2.8.14 -> 2.8.16(Spring Boot 3)
Springdoc(Spring Boot 4):3.0.2
版本摘要:本版本重点增强微服务聚合下的 context-path 自动发现、服务状态管理和在线调试交互,提升网关场景的稳定性与可用性。
新增功能 · 后端(网关聚合与 context-path 自动发现)
3 项新增新增微服务 context-path 自动发现能力,支持从注册中心 metadata 解析 nextdoc4j.context-path 等 key,并将服务 context-path 自动拼接到聚合文档地址。
在 starter 侧新增 context-path 元数据发布机制,自动将 server.servlet.context-path 注入服务注册 metadata,保证网关可感知。
增强网关文档改写能力,统一合并全局安全配置并修正 OpenAPI servers.url。
新增聚合模式的服务选择器、服务菜单与动态路由生成能力,支持按服务维度浏览文档。
新增聚合模式下 OpenAPI 数据缓存、标签页状态记忆与服务切换状态管理,减少重复请求。
新增服务状态探测与容错切换能力,提升聚合模式稳定性。
新增请求参数 Content-Type 设置与处理能力,支持更完整的请求体调试。
新增复制 baseUrl 与 path 功能,提升在线调试效率。
新增菜单图标组件与图标渲染支持。
实体模型菜单新增 JSON 示例视图,并优化实体属性展示。
将 Swagger URLs 刷新改为异步触发(路由刷新/心跳/请求前),优化网关与微服务启动时序下的数据一致性。
优化服务上下文路径解析策略(注册中心、路由 metadata、本地缓存协同),提升重启场景下的更新及时性。
精简文档响应重写过滤器,移除冗余逻辑与无用方法,统一路径处理常量并完善代码注释规范。
适配聚合模式下在线测试功能,修复服务切换后的调试请求问题。
修复数组类型 items 引用 Schema 的解析问题。
修复全局认证样式无法折叠问题。
修复 icon 组件在响应式场景下的图标名称解析问题。
修正 Markdown 解析器配置,允许原始 HTML 渲染。
修复请求体内容类型与表单参数处理的异常场景。
版本摘要:本版本补齐版本号提供、网关聚合插件和路由策略能力,并精简配置、依赖与模块边界。
新增网关聚合文档插件,实现 Spring Cloud Gateway 文档聚合功能。
支持路由包含及排除策略,灵活控制聚合范围。
支持多种策略解析文档路径与显示名称。
支持自动发现和手动配置两种方式提供 Swagger URL。
提供丰富的配置选项,包括路由过滤、名称解析、文档路径策略等。
优化扩展配置加载逻辑,分离基础信息与扩展配置。
统一网关插件接口命名规范,提升扩展一致性。
精简配置属性结构,优化代码逻辑。
优化模块间依赖关系,移除冗余依赖声明。
版本摘要:本版本优化响应数据加载反馈,并修复认证过滤逻辑中的请求方法判断问题。
版本摘要:本版本完善应用版本与请求交互反馈,优化编辑器高度和 Sa-Token 路径排除处理。
功能优化 · 后端(Sa-Token 插件)
3 项优化优化路径排除器实现,通过 SpringUtil.getBean() 延迟获取替代构造函数注入。
解决用户自定义多个 RequestMappingHandlerMapping Bean 时的注入冲突问题。
降低 AutoConfiguration 与实现类的耦合度。
版本摘要:本版本新增认证展示、Sa-Token 适配和枚举解析能力,完善 API 权限信息与枚举数据的可视化展示。
新增接口认证信息展示插件,支持 OpenAPI Security 元数据统一解析和展示。
新增 Sa-Token 适配模块,实现权限、角色及忽略规则注解的解析与展示。
支持全局和接口级别的鉴权配置,自动注入 OpenAPI 鉴权信息。
引入路径排除机制,基于注解动态排除特定接口的鉴权。
新增认证展示组件,支持 API 访问权限及权限要求明细展示。
增强枚举展示功能,支持枚举描述展示,格式(1 - 启用,0 - 未启用)。
JSON 查看器、参数视图、模式视图组件均支持扩展枚举信息展示。
版本摘要:本版本完善枚举插件自动配置、枚举值描述映射和 JSON 展示能力,并清理冗余依赖与自动装配问题。
增强枚举参数与模型处理能力,支持参数与模型中的枚举类型完整自定义处理。
统一设置枚举类型的 enum 列表、type、format。
新增枚举值与描述映射信息追加展示。
优化枚举描述 Map 的生成顺序与安全性,确保展示稳定。
从 nextdoc4j-core 与 nextdoc4j-dependencies 移除 jackson-databind 冗余依赖。
为 NextDoc4jExtensionOpenApiCustomizer 添加 @SuppressWarnings 处理无效警告。
清理多余依赖声明,规整 pom.xml 配置。
优化枚举参数处理与自动装配逻辑,移除无效注解,并统一注入 ObjectMapper。
版本摘要:本版本优化路径匹配与 HTML API 描述展示,并修复主题、认证参数和测试按钮交互问题。
修复深色模式下全局认证样式异常问题,统一视觉表现。
修复 header / query 参数名与 securitySchemes 定义不一致的问题,保证认证参数解析正确。
修复测试按钮未禁用导致的重复点击问题,避免多次请求触发。
版本摘要:本版本重构 API 详情页与全局认证 UI,优化左右分栏阅读体验并修复带前缀路径的过滤匹配问题。
Jackson 升级:2.18.2 -> 2.20.0
Spring Boot3 升级:3.5.5 -> 3.5.6
Springdoc 升级:2.8.13 -> 2.8.14
Hutool 升级:5.8.37 -> 5.8.41
Swagger 升级:2.2.36 -> 2.2.39
版本摘要:本版本优化主页视觉、上下文路径、列表解析和文件上传展示,并修复标题一致性与双 JSON 折叠问题。
功能优化 · Spring Boot 适配
1 项优化BUG 修复 · Body 双 JSON 折叠
1 项修复版本摘要:NextDoc4j 首个正式版本,围绕 SpringDoc / OpenAPI 3 提供现代化 API 文档 UI、配置管理、认证和品牌定制能力。
核心适配:深度适配 SpringDoc 与 OpenAPI 3 规范,提供全新现代化文档 UI,替代传统 Swagger UI,优化 API 文档展示与交互体验。
配置管理:支持开关配置(可灵活控制文档 UI 功能启用 / 禁用)与生产模式配置(适配生产环境下的文档访问权限与安全管控)。
认证功能:新增认证登录模块,保障 API 文档访问安全性,防止未授权用户查看敏感接口信息。
品牌定制:支持品牌 logo 与标题自定义配置,可根据团队或项目需求替换默认标识,强化品牌辨识度。
登录界面美化:实现动态标题与动态 logo 效果,支持配置化展示,提升品牌辨识度。
主页优化:同步增加主页动态标题与动态 logo 配置,与登录界面保持整体视觉统一。