ERPTurbo_Poster/openspec/changes/archive/2025-11-20-standardize-api-responses/proposal.md
shenyifei dc940d2598 feat(api): 添加海报和PDF生成功能
- 新增海报生成接口,支持从网页URL或HTML内容生成海报图像
- 新增PDF生成接口,支持从网页URL或HTML内容生成PDF文档
- 添加Swagger API文档注释,完善接口描述和参数说明
- 实现HTML内容参数支持,允许直接传入HTML结构生成海报/PDF
- 添加输入验证和标准化响应格式
- 引入DOMPurify库对HTML内容进行安全过滤
- 更新环境变量配置,支持API密钥认证和CORS设置
- 优化上传逻辑,统一返回标准响应结构
- 添加构建脚本支持Docker镜像打包和推送
2025-11-20 17:51:35 +08:00

880 B
Raw Blame History

Change: 标准化ERPTurbo_Poster API响应格式

Why

当前ERPTurbo_Poster服务的API响应格式不一致存在多种响应结构包括健康检查返回空对象、海报生成返回{url}、上传函数返回{name, path}等。这种不一致性增加了客户端开发的复杂性降低了API的可预测性和可维护性。

What Changes

  • 创建统一的响应格式结构:{success, data, message, code}
  • 更新海报生成接口(/api/v1/poster)使用标准响应格式
  • 更新PDF生成接口(/api/v1/pdf)使用标准响应格式
  • 保持健康检查接口(/status)的响应格式兼容性
  • 实现响应格式辅助函数以简化开发

Impact

  • Affected specs: response-format (新增)
  • Affected code: lib/routes.js, lib/response.js
  • BREAKING: API响应格式发生变化需要客户端适配
  • 提升了API的一致性和开发者体验