Commit Graph

2 Commits

Author SHA1 Message Date
Table
84055fecfe feat: 优化 API 文档生成和 Swagger UI 服务
- 优化 make docs 命令:
  * 自动检查并安装 swag 工具
  * 自动过滤 swag 生成过程中的警告信息
  * 自动修复生成的 docs.go 文件中的兼容性问题(移除 LeftDelim 和 RightDelim 字段)

- 优化 make docs-serve 命令:
  * 使用 Docker 运行 Swagger UI 容器,提供完整的 Swagger UI 界面
  * 新增 make docs-stop 命令,用于停止 Swagger UI 容器
  * 引入 SWAGGER_PORT 变量统一管理 Swagger UI 端口配置(默认 8081)

- 修复应用内置 Swagger UI 无法加载文档问题:
  * 在 main.go 中导入生成的 docs 包(_ "yinli-api/doc/dev")
  * 修复 docs.go 文件中的兼容性问题
  * 解决 "Failed to load API definition" 错误

- 更新 CHANGELOG.md,记录所有变更
2025-11-29 20:07:24 +08:00
Table
b1ddecc45e docs: 添加 CHANGELOG.md 升级日志并清理 PDF 文件
- 新增 CHANGELOG.md 文件,记录项目所有重要变更
- 按功能类型分类(新增功能、改进优化、问题修复、文档更新)
- 包含未发布版本和 2025-11-29 开发阶段的变更记录
- 删除 PROJECT_SUMMARY.pdf 和 README.pdf 文件
2025-11-29 19:27:42 +08:00