开放 API 文档 PDF 验证报告

2026-09-09 · 后端生成,页面直接下载 · 验证通过

文档页新增“导出 PDF”。网页与 PDF 共用后端接口说明,输入参数来自 OpenAPI 契约。保留原有契约下载入口。无需打印窗口、外部转换服务或数据库变更。

查看下载样例(29 页) · 浏览器测试结果

检查项结果
匿名文档页加载与实际文件下载通过:13 个接口,PDF 文件头、文件名与响应类型正确。
失败提示与重试通过:浏览器拦截下载请求模拟 503,显示 message;按钮恢复后可重新下载。
目录滚动联动通过:滚动至第 9 个接口时,左侧目录对应选中。
后端自动化测试通过:接口覆盖与契约一致;每个接口包含描述、输入、输出、错误码;14 个书签;字体嵌入;缓存返回一致。
前端类型检查通过:vue-tsc --noEmit。
PDF 排版检查29 页全部渲染检查,中文、表格、示例与页码可读,无内容重叠或裁切。

页面下载

开放 API 文档页面下载 PDF 成功提示

PDF 参数表预览

PDF 第 19 页:成片生成任务的输入参数表

实施与验证范围

后端使用 ReportLab,随包提供获许可的中文字体并嵌入 PDF。新增公开文档数据接口与 PDF 下载接口,仅输出静态说明和占位示例。开发服务已重启并实测;本轮未重复测试数字人业务生成流程,也未部署到生产环境。

复现脚本:ute2e/tools/open-platform-pdf.mjs;后端测试:tests/test_open_api_documentation.py。