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

653 B
Raw Permalink Blame History

Change: 添加Swagger接口文档生成工具

Why

当前项目缺乏API文档开发者需要通过阅读代码来理解API端点的使用方法。添加Swagger文档将改善开发者体验提供交互式API文档便于测试和集成。

What Changes

  • 集成Swagger UI用于交互式API文档
  • 添加Swagger规范生成
  • 为现有的API端点生成文档注释
  • 创建API端点的详细描述和参数说明

Impact

  • 受影响的规格: documentation/api-docs
  • 受影响的代码:
    • server.mjs (添加Swagger中间件)
    • package.json (添加Swagger依赖)
    • 新增API文档注释文件或在现有文件中添加注释