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.5.0
SSE 流式调试
实时事件流 / 虚拟滚动
Sa-Token 权限码
原生注解自动识别联动
枚举智能释义
下拉单选与字典自动绑定
微服务网关聚合
WebFlux / WebMvc 自动路由
TS / Java 实体生成
一键生成 Request/Response
http://localhost:8080/doc.html
NextDoc4j 项目概览、接口统计与文档导航（浅色）NextDoc4j 项目概览、接口统计与文档导航（深色）

三步接入 Spring Boot 项目

保留现有的 SpringDoc 接口描述，添加依赖、启用配置，即可打开文档工作台。

快速接入
NextDoc4j 1.5.0
完整接入指南

JDK 17+ · Maven 3.9+
Spring Boot 3 / 4

XMLpom.xml
<dependency>    <groupId>top.nextdoc4j</groupId>    <artifactId>nextdoc4j-spring-boot-starter</artifactId>    <version>1.5.0</version></dependency><dependency>    <groupId>org.springdoc</groupId>    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>    <version>2.9.1</version></dependency>

Boot 3 使用 SpringDoc 2.x，示例版本 2.9.1。已有 SpringDoc UI 时复用兼容版本。

适配单体应用与微服务网关

SpringDoc 生成 OpenAPI，NextDoc4j 提供工作台。根据部署方式选择对应 Starter。

接入架构
随应用部署

应用内直接使用

页面资源随 JAR 提供，文档与接口位于同一应用。WebMVC 与 WebFlux 共用单体 Starter。

  • 文档与接口同源访问
  • 复用 SpringDoc 接口分组
引入的 Starternextdoc4j-spring-boot-starter
接入说明单体在线演示

从接口定义到在线调试

字段含义、权限要求和请求过程，在同一个工作台中查看和处理。

JSON 请求正文中展开 status 枚举，同时显示候选值和中文业务含义
EnumValue<T>

枚举字段可以直接选择

枚举插件把值与业务含义写入文档。JSON Body、Query 和表单可直接选择，写入实际请求。

接口详情展示 OR 权限组合与 admin 角色分支
@SaCheckPermission

权限与角色跟随接口展示

Sa-Token 插件解析 MVC 应用中的注解，展示 AND / OR 权限组合与角色要求。业务鉴权由宿主执行。

SSE 流式响应

逐条查看事件内容，按需终止当前连接。

请求前后置操作

可视化步骤与 JavaScript 脚本，提取变量、回填认证。

文档导出与交付

OpenAPI、Markdown、HTML、Word，以及打印 PDF。

浏览全部界面功能

按需配置工作台

自定义入口与品牌，配置文档密码，按环境控制开放范围。

工作台配置

品牌与入口

设置工作台和登录页的标题、Logo，并指定文档入口。

将 Logo 放入宿主的 classpath:/brand/logo.svg，重启后通过 /docs 访问。

查看配置说明
YMLapplication.yml
nextdoc4j:  enabled: true  doc-path: /docs  extension:    enabled: true    brand:      title: 订单开放平台      logo: classpath:/brand/logo.svg

文档、源码与社区

NextDoc4j 基于 Apache-2.0 开源，欢迎反馈问题、完善文档和参与开发。

GitHubGiteeGitCode
认识社区，加入讨论