feat(server): 集成 Swagger API 文档
- 引入 swaggo/gin-swagger 和 swaggo/files 依赖 - 配置 Swagger UI 路由 /swagger/* - 为测试 handler 函数添加 Swagger 注解 - 将 main.go 中的内联 handler 重构到 handler/test.go 以支持注解 - 生成 Swagger 文档 (docs.go, swagger.json, swagger.yaml) - Makefile 新增 make swagger 命令 - .gitignore 添加 server/docs/ 以跟踪生成的文档 - 添加 API 元信息(标题、版本、联系方式、许可证、安全定义)
This commit is contained in:
@@ -13,6 +13,7 @@ help:
|
||||
@echo " make test - 运行测试"
|
||||
@echo " make docker - 构建 Docker 镜像"
|
||||
@echo " make clean - 清理构建产物"
|
||||
@echo " make swagger - 生成 Swagger API 文档"
|
||||
@echo ""
|
||||
|
||||
# 构建前后端项目
|
||||
@@ -75,6 +76,12 @@ dev-down:
|
||||
@echo "Stopping local development environment..."
|
||||
docker-compose down
|
||||
|
||||
# Swagger 文档
|
||||
swagger:
|
||||
@echo "Generating Swagger documentation..."
|
||||
cd server && swag init -g cmd/server/main.go -o ./docs
|
||||
@echo "Swagger docs generated at server/docs/"
|
||||
|
||||
# 数据库迁移
|
||||
migrate-up:
|
||||
@echo "Running database migrations..."
|
||||
|
||||
Reference in New Issue
Block a user