Skip to content

界面功能总览

NextDoc4j 提供高度现代化、开箱即用的前端交互工作台。本篇系统介绍接口多维浏览、在线交互调试、权限可视化与全量导出能力。

前端能力地图

功能域主要能力入口/位置
文档浏览分组导航、分组概览(1.4.0)、接口详情工作台、实体模型浏览、TypeScript 实体代码生成首页、分组概览与文档详情页
在线调试Path / Query / Header / Cookie / Body 五维联动、Content-Type 自动补全、文件上传、SSE 流式事件、请求缓存接口详情页调试工作台
认证与权限全局认证配置中心、接口权限元数据可视化(含 Sa-Token 深度集成)全局认证页与文档详情页
文档扩展离线 Markdown 文档导航与渲染、架构说明与部署规范挂载左侧菜单
网关聚合服务选择器、按微服务维度隔离菜单与接口路由、聚合模式动态路由修正网关模式下首页与文档页
全局效率工具全局搜索、公共请求参数管理、专业文档导出(含 docx / PDF)顶部工具栏与独立导出中心
视觉与体验明暗主题沉浸切换、系统主题自动跟随、流式响应式布局全站

1. 现代化文档浏览

  • 支持按分组、标签和路径多维浏览接口;1.4.0 全新推出接口分组概览页。
  • 接口详情工作台支持请求参数、响应结构、多状态码示例联动查看。
  • 支持参数视图、模式视图、状态码切换,以及 oneOf / anyOf 分段选择与请求/响应 TypeScript 实体代码一键生成。
  • 实体模型区域支持结构化浏览与 JSON / XML 示例视图。
接口分组概览工作台(1.4.0+)
Overview
接口分组概览工作台(1.4.0+)
集中呈现当前分组下全部 API 列表、请求方式彩色徽章及业务说明
接口详情工作台
接口详情工作台
多响应示例、状态码切换与结构化入参视图
TS 实体代码生成弹窗
TypeScript 实体代码示例
前端一键生成 TypeScript Request / Response 实体定义

2. 沉浸式在线调试与 SSE 事件流

  • 支持 Path / Query / Header / Cookie / Body 五类参数联动编辑与校验。
  • 支持请求体 Content-Type 切换与智能自动补全,轻松适配 form-data / x-www-form-urlencoded / json / raw / binary 调试场景。
  • 支持文件上传与表单混合参数调试。
  • 支持实时响应、响应头、原请求三类结果页签,以及多内容类型高亮(含 XML 高亮)与 JSON 结构树。
  • 1.4.0 引入 SSE 流式事件实时展示、打字机渲染、耗时监控与手动终止。
  • 支持请求参数持久化缓存,减少重复输入。
SSE 流式事件调试面板(1.4.0+)
SSE Streaming
SSE 流式事件调试面板(1.4.0+)
原生支持 Server-Sent Events 事件逐条推送、打字机渲染与耗时监控

3. 认证授权与网关微服务聚合

  • 全局认证中心:自动读取 securitySchemes 生成独立配置页,在线调试自动携带认证 Token。
  • 权限元数据可视化:支持 Sa-Token 注解(@SaCheckPermission@SaCheckRole@SaIgnore)解析与徽章展示。
  • 网关微服务聚合:自动识别微服务网关模式,提供顶部服务选择器,按服务隔离菜单与接口路由。

相关文档