All checks were successful
构建并部署到测试环境(无 SSH) / build-and-deploy (push) Successful in 5m33s
主要改动: - 新增交互式环境配置脚本 (scripts/setup-env.sh) - 新增本地启动快捷脚本 (scripts/run-local.sh) - 新增环境变量模板文件 (.env.example) - 部署模式改版:使用嵌入式配置 + 环境变量覆盖 - 添加对象存储功能支持 - 改进 IoT 卡片导入任务 - 优化 OpenAPI 文档生成 - 删除旧的配置文件,改用嵌入式默认配置
920 B
920 B
1. RouteSpec 结构体扩展
- 1.1 在
internal/routes/registry.go的 RouteSpec 结构体中新增 Description 字段
2. OpenAPI 生成器修改
- 2.1 修改
pkg/openapi/generator.go的 AddOperation 方法签名,增加 description 参数 - 2.2 在 AddOperation 方法中设置 op.Description 字段
- 2.3 修改 AddMultipartOperation 方法签名,增加 description 参数
- 2.4 在 AddMultipartOperation 方法中设置 op.Description 字段
3. Register 函数更新
- 3.1 更新
internal/routes/registry.go的 Register 函数,传递 spec.Description 给生成器
4. 文档更新
- 4.1 更新
docs/api-documentation-guide.md,新增 Description 字段使用说明 - 4.2 补充 Markdown 语法示例和最佳实践
5. 验证
- 5.1 运行
go run cmd/gendocs/main.go验证文档生成正常 - 5.2 检查生成的 YAML 文件格式正确