验收通过

开放应用与 API 文档调整

数字人服务系统 · 2026-09-09 · 开发环境真实页面验证

开放应用统一使用现有系统的标题、搜索工具栏、列表和底部分页。API 文档从开放应用页内进入,采用目录导航与完整正文,每个接口直接展示描述、输入参数、输出参数、返回示例和错误码。

13 / 13业务接口完整展示
8浏览器检查组通过
33相关后端测试通过
6真实数据库搜索检查通过

本次变更与验证

项目结果
页面风格使用统一语义色、系统页面容器、Element Plus 表格、工具按钮和分页;浅色、深色均截图检查。
文档入口菜单仅保留开放应用,右上角按钮进入文档二级页;当前菜单继续高亮开放应用,返回按钮可正常回到列表。
文档内容13 个接口与运行中的 OpenAPI 契约逐项比对;无折叠组件,每个接口均包含四个章节和返回示例。参数类型、默认值与范围取自服务端契约。
参数与错误码明确请求头、路径、查询和 JSON 参数;注明幂等键必填、视频尺寸范围、授权要求;区分 HTTP 业务码、任务失败码和二进制响应。
移动端与外部访问公共文档 /developer 无需登录;390px 窄屏无页面横向溢出,宽参数表在表格内滚动。
附带修复KingBase MySQL 兼容模式下,原 contains 查询中的 || 被解释为逻辑运算,造成搜索返回全部数据。改为绑定完整 LIKE 参数,并转义通配符;应用名称、APPID 和授权资源搜索验证通过。

前端 pnpm exec vue-tsc --noEmit 通过。后端菜单测试 5 项、迁移测试 23 项、开放平台测试 5 项通过;后者包含新增关键词和字面通配符回归用例。真实 KingBase 对应用及五类资源的不匹配关键词均返回 0 条。浏览器无未捕获脚本错误。

数据库迁移 20260909_034_open_api_docs_secondary.sql 已在开发库执行并复核:软删除文档菜单及其权限关联,保留访问权限本身;恢复默认菜单不会重新出现文档。全量 DDL 和接口说明已同步。

环境说明:测试期间发现开发配置使用 2 个数据库连接且无溢出连接,后台任务和页面并发曾触发连接池等待。本次运行进程按代码默认值使用 pool_size=10、max_overflow=20,未修改持久化连接配置。本轮未重复视频生成业务测试,也未更改应用密钥、授权数据或成片协议。

浏览器检查结果 JSON · 可复跑的 E2E 脚本

页面截图

点击截图可查看原图。

浅色开放应用列表,统一工具栏和分页
开放应用:标题、搜索、重置、新建、列表和底部分页统一。
文档二级页面,系统菜单仅显示开放应用
文档二级页:左侧系统菜单不展示文档,页内目录提供接口定位。
成片生成接口描述和输入参数
接口正文:请求方式、路径、权限和输入参数表直接呈现。
深色文档页
文档深色主题。
深色开放应用列表
开放应用深色主题。
深色应用配置弹窗
配置弹窗沿用系统主题,授权资源区域正常显示;测试未保存修改。
390像素移动端公共文档入口
移动端:公共文档与目录。
移动端参数表,表格内部横向滚动
移动端:宽参数表内部滚动,页面本身不溢出。

单个接口完整展示

以“提交成片生成任务”为例,以下完整截图覆盖描述、输入参数、输出参数、返回示例和错误码。

成片生成接口四个章节完整截图