dc940d2598
- 新增海报生成接口，支持从网页URL或HTML内容生成海报图像 - 新增PDF生成接口，支持从网页URL或HTML内容生成PDF文档 - 添加Swagger API文档注释，完善接口描述和参数说明 - 实现HTML内容参数支持，允许直接传入HTML结构生成海报/PDF - 添加输入验证和标准化响应格式 - 引入DOMPurify库对HTML内容进行安全过滤 - 更新环境变量配置，支持API密钥认证和CORS设置 - 优化上传逻辑，统一返回标准响应结构 - 添加构建脚本支持Docker镜像打包和推送
39 lines
1.5 KiB
Markdown
39 lines
1.5 KiB
Markdown
# 任务：标准化ERPTurbo_Poster API响应格式
|
||
|
||
## 实施任务列表
|
||
|
||
### 1. 创建响应格式工具函数
|
||
- [x] 创建统一的响应格式工具函数
|
||
- [x] 实现成功响应函数：successResponse(data, message?, code?)
|
||
- [x] 实现错误响应函数：errorResponse(message, code?, details?)
|
||
|
||
### 2. 更新路由处理函数
|
||
- [x] 修改 posterHandler 函数以使用新的响应格式
|
||
- [x] 修改 pdfHandler 函数以使用新的响应格式
|
||
- [x] 修改 statusHandler 函数以使用新的响应格式
|
||
|
||
### 3. 更新上传处理函数
|
||
- [x] 修改 upload 函数以 return standardized response instead of sending directly
|
||
- [x] 确保所有存储后端（本地、COS、OSS）返回一致的格式
|
||
|
||
### 4. 更新API文档
|
||
- [x] 更新 server.mjs 中的 Swagger 文档，反映新的响应格式
|
||
- [x] 更新 lib/routes.js 中的 Swagger 注释
|
||
- [x] 更新 README.md 中的 API 响应示例
|
||
|
||
### 5. 测试验证
|
||
- [x] 测试海报生成接口的响应格式
|
||
- [x] 测试PDF生成接口的响应格式
|
||
- [x] 测试错误情况下的响应格式
|
||
- [x] 测试认证失败时的响应格式
|
||
- [x] 确保向后兼容性（如需要）
|
||
|
||
### 6. 部署注意事项
|
||
- [x] 更新 API 文档，告知客户端开发者响应格式变化
|
||
- [x] 考虑提供版本控制或临时兼容层（如需要）
|
||
|
||
### 7. 验证和验收
|
||
- [x] 验证所有API端点都返回一致的响应格式
|
||
- [x] 确保错误响应包含适当的错误代码和消息
|
||
- [x] 确保成功响应包含适当的响应数据
|
||
- [x] 运行所有测试验证功能正常 |