fix: 修复一系列问题并生成swagger一键脚本

2026-04-28 13:36:48 +08:00
parent 10d5578a43
commit d939c2d5e1
10 changed files with 272 additions and 194 deletions
@@ -464,6 +464,27 @@ go run ./cmd/server
 http://localhost:3001/swagger/index.html
 ```

+### 9.4 生成 Swagger 文档
+
+仓库根目录提供了两个脚本，方便重新生成 API 文档：
+
+- Linux / WSL / macOS：`./gen_swagger.sh`
+- Windows PowerShell：`./gen_swagger.ps1`
+
+脚本会自动切换到 `backend/` 目录，并执行：
+
+```bash
+swag init -g ./cmd/server/main.go --parseDependency --parseInternal
+```
+
+生成产物位于 `backend/docs/` 下：
+
+- `docs.go`
+- `swagger.json`
+- `swagger.yaml`
+
+如果遇到 `cannot find type definition: model.GraphData` 之类的报错，通常是 handler 文件里缺少 `internal/model` 的显式导入。
+
 ---

 ## 十、当前实现特点