Skip to content

Commit 5da3551

Browse files
committed
feat: 添加 Swagger 文档支持和更新 API 注释
- 在项目中集成 Swagger 以生成 API 文档 - 更新多个控制器的注释以符合 Swagger 格式 - 添加 Swagger 文档路由 - 修改响应结构以统一 API 返回格式 - 更新 .gitignore 文件以排除生成的文档目录
1 parent 9b811b6 commit 5da3551

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+25027
-155
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -279,4 +279,5 @@ Icon
279279
Network Trash Folder
280280
Temporary Items
281281
.apdisk
282-
public/*
282+
public/*
283+
gotribe-admin

Makefile

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,14 @@ install: build # 安装到系统
119119
uninstall: # 从系统卸载
120120
@rm -f /usr/local/bin/$(PROJECT_NAME)
121121

122+
.PHONY: swagger
123+
swagger: # 生成 Swagger 文档
124+
@swag init -g ./gotribe-admin.go -o ./docs
125+
126+
.PHONY: swagger-clean
127+
swagger-clean: # 清理 Swagger 文档
128+
@-rm -vrf $(ROOT_DIR)/docs
129+
122130
.PHONY: help
123131
help: # 显示帮助信息
124132
@echo "Available targets:"
@@ -141,4 +149,6 @@ help: # 显示帮助信息
141149
@echo " install - 安装到系统"
142150
@echo " uninstall - 从系统卸载"
143151
@echo " clean - 清理构建产物"
152+
@echo " swagger - 生成 Swagger 文档"
153+
@echo " swagger-clean- 清理 Swagger 文档"
144154
@echo " help - 显示帮助信息"

0 commit comments

Comments
 (0)