Skip to content

NextDoc4j现代化 API 文档 UI 工具

专为 SpringDoc 和 OpenAPI 3 设计的现代化文档界面, 替代 Swagger UI,提供更美观、更强大的开发体验。 让 API 文档焕然一新。

NextDoc4j

🌟 为什么选择 NextDoc4j?

告别传统 Swagger UI 的局限性,拥抱现代化的 API 文档体验。NextDoc4j 不仅仅是一个 UI 替换工具,更是为 Java 开发者量身定制的文档解决方案。

✨ 核心优势

🔄

零学习成本

完全兼容 SpringDoc 和 OpenAPI 3 规范,无缝迁移现有项目

🎯

企业级定制

支持品牌化定制和主题配置,满足企业级项目需求

👨‍💻

开发者友好

提供直观的 API 调试界面和便捷的参数测试功能

🌟

体验焕新

告别传统界面束缚,享受现代化的 API 文档浏览体验

🚀 三步即刻体验

📋 版本要求

仅支持 Spring Boot 3.4.x - 确保您的项目版本符合要求

第一步:引入依赖

xml
<dependency>
    <groupId>top.nextdoc4j</groupId>
    <artifactId>nextdoc4j-springboot3-starter</artifactId>
    <version>1.0.0</version>
</dependency>

第二步:添加配置

application.ymlapplication.properties 中添加配置:

yaml
nextdoc4j:
  enabled: true  # 是否启用 NextDoc4j,默认 false
properties
nextdoc4j.enabled=true

第三步:访问文档

启动应用后,在浏览器中访问:

http://localhost:端口/doc.html

💡 提示

  • 默认端口通常是 8080
  • 完整地址示例:http://localhost:8080/doc.html
  • 启用全局鉴权的项目需要配置路径白名单:/doc.html 和 /nextdoc/**

主界面预览

NextDoc4j 主界面NextDoc4j 主界面
🎯 界面功能说明
  • 左侧导航栏:展示所有API分组和接口列表
  • 右侧内容区:显示接口详细信息、参数说明和调试功能
  • 顶部搜索栏:快速查找特定接口
  • 在线调试:直接在页面中测试API接口