dc940d2598
- 新增海报生成接口，支持从网页URL或HTML内容生成海报图像 - 新增PDF生成接口，支持从网页URL或HTML内容生成PDF文档 - 添加Swagger API文档注释，完善接口描述和参数说明 - 实现HTML内容参数支持，允许直接传入HTML结构生成海报/PDF - 添加输入验证和标准化响应格式 - 引入DOMPurify库对HTML内容进行安全过滤 - 更新环境变量配置，支持API密钥认证和CORS设置 - 优化上传逻辑，统一返回标准响应结构 - 添加构建脚本支持Docker镜像打包和推送
1.2 KiB
1.2 KiB
ADDED Requirements
Requirement: Swagger API文档
系统应提供交互式API文档，使开发者能够浏览和测试API端点。
Scenario: 访问Swagger UI界面
- WHEN 用户访问
/api-docs端点 - THEN 系统应显示Swagger UI界面
- AND 界面应列出所有可用的API端点
Scenario: 测试API端点
- WHEN 用户在Swagger UI界面中选择一个API端点并提供参数
- THEN 系统应允许用户执行API调用
- AND 应显示API响应结果
Requirement: API端点文档
所有API端点都应有详细文档，包括参数、请求体和响应格式。
Scenario: 查看海报API文档
- WHEN 用户在Swagger UI中查看海报API端点
- THEN 应显示所有支持的参数（webpage, device, width, height, type, encoding等）
- AND 应提供参数类型、默认值和描述
Scenario: 查看PDF API文档
- WHEN 用户在Swagger UI中查看PDF API端点
- THEN 应显示所有支持的参数（webpage, html, device, width, height等）
- AND 应提供参数类型、默认值和描述
Scenario: 查看健康检查API文档
- WHEN 用户在Swagger UI中查看健康检查API端点
- THEN 应显示该端点的描述和响应格式