🚀 现代化的 API 文档后端解决方案
基于 SpringBoot 3.4.x + SpringDoc 构建，替代 Swagger UI，
提供更美观、更强大的开发体验，让 API 文档焕然一新。
🌐 在线演示 | 📘 官方文档 | 🧩 更新日志 | ❓ 常见问题
| 平台 | 仓库地址 |
|---|---|
| GitCode | https://gitcode.com/NextDoc4j/nextdoc4j |
| Gitee | https://gitee.com/nextdoc4j/nextdoc4j |
| GitHub | https://github.com/NextDoc4j/nextdoc4j |
Nextdoc4j 是一款现代化的 API 文档后端解决方案，专为 SpringDoc 和 OpenAPI 3 设计。它深度适配 SpringDoc 生态系统，在保留 API 文档核心功能的基础上，提供更强的安全性、灵活的配置能力以及优化的交互体验，完美替代传统的 Swagger UI。
NextDoc4j 帮助开发团队提高 API 文档的管理和调试效率，使文档系统成为研发流程中的得力助手。
- 🎨 现代化界面 - 与前端深度整合，提供比 Swagger UI 更优雅的体验
- 🔒 安全认证 - 内置简单登录校验，保护接口文档安全
- 🛠️ 灵活配置 - 支持功能开关、生产模式等多维度配置
- 🚀 深度适配 - 专为 SpringDoc 和 OpenAPI 3 优化
- 🎯 品牌定制 - 支持自定义 logo、标题等品牌元素
直观的API文档首页，集成项目概览、业务分组和快速定位功能
接口详情页面，集成在线调试工具，支持参数输入、响应预览和JSON数据结构化展示
接口在线调试页面，支持请求方法选择、参数输入、请求头编辑、实时响应预览及 JSON 结构化展示，可直接发起 API 调用并查看返回数据详情
支持动态 title 和 logo 渲染，可配置化自定义
- Java: >= 17
- SpringBoot: >= 3.4.x
- SpringDoc: 与 OpenAPI 3 兼容
在 pom.xml 中添加以下依赖：
<dependency>
<groupId>top.nextdoc4j</groupId>
<artifactId>nextdoc4j-springboot3-starter</artifactId>
<version>{latest-version}</version>
</dependency>在 application.yml 或 application.properties 中添加配置：
application.yml:
nextdoc4j:
enabled: true # 是否启用 NextDoc4j，默认 falseapplication.properties:
nextdoc4j.enabled=true启动应用后，访问 http://localhost:端口/doc.html 即可使用 nextdoc4j 文档系统。
更多配置和使用方式请参考 官方文档。
- 核心框架: SpringBoot 3.4.x
- 文档规范: SpringDoc + OpenAPI 3
- 构建工具: Maven
- JDK版本: Java 17+
我们欢迎所有形式的贡献！包括但不限于：
- 🐛 提交 Bug 反馈
- 💡 提供功能建议
- 📝 改进文档
- 💻 贡献代码
详细的贡献指南请访问：贡献指南
- 官方文档: https://nextdoc4j.top
- 贡献指南: https://nextdoc4j.top/more/contribute.html
- 更新日志: https://nextdoc4j.top/more/changelog.html
- 常见问题: https://nextdoc4j.top/more/faq.html
- 团队介绍: https://nextdoc4j.top/more/team/team.html
本项目基于 Apache-2.0 License 开源协议，详见项目根目录的 LICENSE 文件。
- SpringDoc - 优秀的 OpenAPI 3 集成框架
- Spring Boot - 强大的 Java 应用框架
- OpenAPI - API 文档标准规范
NextDoc4j - 让 API 文档焕然一新！ 如果这个项目对你有帮助，请给它一个 ⭐️