ERPTurbo_Poster/openspec/changes/archive/2025-11-14-add-swagger-docs/add-swagger-docs/tasks.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

12 lines
428 B
Markdown

## 1. 实现
- [ ] 1.1 添加Swagger相关依赖到package.json
- [ ] 1.2 配置Swagger UI中间件
- [ ] 1.3 为海报API端点(/api/v1/poster)添加文档注释
- [ ] 1.4 为PDF API端点(/api/v1/pdf)添加文档注释
- [ ] 1.5 为健康检查API端点(/status)添加文档注释
- [ ] 1.6 配置Swagger规范生成
- [ ] 1.7 验证API文档的准确性
- [ ] 1.8 添加API示例和参数说明
- [ ] 1.9 编写相关测试