界面功能总览
本分组聚焦 前端界面能力(可见可用的功能),不是后端配置项说明。
功能地图
| 功能域 | 主要能力 | 入口/位置 |
|---|---|---|
| 文档浏览 | 分组导航、分组概览、接口详情工作台、实体模型浏览、菜单图标 | 首页、分组概览与文档详情页 |
| 在线调试 | Path / Query / Header / Cookie / Body 联动、Content-Type 自动补全、文件上传、响应渲染(含 XML)、SSE 流式事件、请求缓存 | 接口详情页调试区 |
| 认证与权限 | 全局认证页、接口权限元数据展示(含 Sa-Token) | 全局认证页与文档详情页 |
| 文档扩展 | Markdown 文档导航与渲染 | 左侧菜单 |
| 网关聚合 | 服务选择器、按服务隔离菜单、聚合模式路由 | 网关模式下首页/文档页 |
| 全局效率工具 | 全局搜索、全局参数管理、文档导出(含 docx) | 顶部工具区/导出页 |
| 视觉与体验 | 明暗主题、系统主题跟随、响应式布局 | 全站 |
1. 文档浏览
- 支持按分组、标签和路径浏览接口;1.4.0 新增接口分组概览页。
- 接口详情工作台支持请求参数、响应结构、示例内容联动查看。
- 支持参数视图、模式视图、多响应示例、状态码切换,以及
oneOf/anyOf分段选择与请求 / 响应TS代码示例。 - 实体模型区域支持结构化浏览,并支持 JSON 示例视图;Body 枚举可选与内容校验。


▲ 接口分组概览(1.4.0)
▲ 接口详情工作台:支持多响应示例与结构化响应视图
▲ 请求参数 TS 实体代码示例弹窗
2. 在线调试
- 支持 Path / Query / Header / Cookie / Body 五类参数联动编辑。
- 支持请求体
Content-Type切换与自动补全、form-data/x-www-form-urlencoded/json/raw/binary等调试场景。 - 支持文件上传与表单混合参数调试。
- 支持实时响应、响应头、原请求三类结果页签,以及响应多内容类型渲染(含 XML 高亮)与 JSON 结构化查看。
- 1.4.0 支持 SSE 事件流实时展示、终止与虚拟滚动。
- 支持复制
baseUrl与path,并支持请求缓存提升重复调试效率。
▲ 在线调试面板:支持实时响应、响应头与原请求查看
▲ SSE 流式调试(1.4.0):事件列表实时展示
3. 认证与权限
- 支持从
securitySchemes生成独立的全局认证配置页。 - 支持在线调试自动携带全局认证信息。
- 支持接口级权限元数据展示。
- 支持 Sa-Token 注解解析后的权限/角色信息展示。
▲ 全局认证配置页
▲ Sa-Token 权限元数据展示
4. 文档扩展
- 支持集成 Markdown 文档并在左侧菜单统一展示。
- 支持按分组组织业务文档与变更记录。
▲ Markdown 文档集成效果
5. 网关聚合
- 自动识别聚合模式并展示服务选择器。
- 支持按服务维度隔离菜单与接口内容。
- 支持聚合场景下的路由状态管理与容错切换。
▲ 网关聚合模式服务切换
6. 全局效率工具
- 全局搜索:支持路径检索、关键字高亮、聚合场景搜索。
- 全局参数管理:支持在导出 / 调试场景复用公共 Header / Query 参数,并统一管理调试缓存。
- 文档导出:支持按分组 / 接口范围导出,支持 Markdown / HTML / OpenAPI JSON /
docx/ PDF,并支持聚合服务导出。
详细操作见:全局搜索与导出
7. 视觉与交互体验
- 支持亮色/暗色主题。
- 支持跟随系统暗色模式自动切换。
- 响应式布局适配桌面与移动端。
- 持续优化菜单、图标、面板布局与可读性。
