package hotime import ( "encoding/json" "fmt" "os" "path/filepath" "sort" "strings" . "code.hoteas.com/golang/hotime/common" ) type swaggerTestCase struct { Name string `json:"name"` Method string `json:"method"` Passed bool `json:"passed"` Query map[string]interface{} `json:"query,omitempty"` Json interface{} `json:"json,omitempty"` Form map[string]interface{} `json:"form,omitempty"` HasFile bool `json:"hasFile,omitempty"` FileField string `json:"fileField,omitempty"` Response map[string]interface{} `json:"response,omitempty"` } func (that *TestApp) GenerateSwagger(title, version, outputDir string) error { if outputDir == "" { outputDir = "tpt" } swaggerRoot := filepath.Join(outputDir, "swagger") if err := os.MkdirAll(swaggerRoot, os.ModePerm); err != nil { return fmt.Errorf("创建 swagger 目录失败: %w", err) } that.collector.mu.Lock() records := make([]TestRecord, len(that.collector.Records)) copy(records, that.collector.Records) that.collector.mu.Unlock() pathRecords := map[string][]TestRecord{} for _, r := range records { pathRecords[r.Path] = append(pathRecords[r.Path], r) } for projName, projDef := range that.projs { moduleDir := filepath.Join(swaggerRoot, projName) if err := os.MkdirAll(moduleDir, os.ModePerm); err != nil { return fmt.Errorf("创建模块目录 %s 失败: %w", projName, err) } endpoints := []map[string]interface{}{} for ctrName, ctr := range projDef.Proj { for methodName := range ctr { apiPath := "/" + projName + "/" + ctrName + "/" + methodName ctrTest, hasCtr := projDef.Tests[ctrName] hasTest := false var apiTest ApiTestDef if hasCtr { apiTest, hasTest = ctrTest[methodName] } summary := methodName if hasTest { summary = apiTest.Desc } recs := pathRecords[apiPath] httpMethod := "POST" if len(recs) > 0 && recs[0].Method != "" { httpMethod = strings.ToUpper(recs[0].Method) } var cases []swaggerTestCase for _, r := range recs { tc := swaggerTestCase{ Name: r.CaseName, Method: r.Method, Passed: r.Passed, Response: r.ResponseBody, } if r.Query != nil { tc.Query = r.Query } if r.JsonBody != nil { tc.Json = r.JsonBody } if r.FormBody != nil { tc.Form = r.FormBody } if r.HasFile { tc.HasFile = true tc.FileField = r.FileField } cases = append(cases, tc) } endpoints = append(endpoints, map[string]interface{}{ "path": apiPath, "project": projName, "ctr": ctrName, "method": httpMethod, "summary": summary, "tested": hasTest, "cases": cases, }) } } sort.Slice(endpoints, func(i, j int) bool { return endpoints[i]["path"].(string) < endpoints[j]["path"].(string) }) spec := map[string]interface{}{ "title": title, "version": version, "endpoints": endpoints, } specJSON, err := json.MarshalIndent(spec, "", " ") if err != nil { return fmt.Errorf("序列化 JSON 失败: %w", err) } if err := os.WriteFile(filepath.Join(moduleDir, "api-spec.json"), specJSON, os.ModePerm); err != nil { return fmt.Errorf("写入 %s/api-spec.json 失败: %w", projName, err) } if err := os.WriteFile(filepath.Join(moduleDir, "index.html"), []byte(apiConsoleHTML()), os.ModePerm); err != nil { return fmt.Errorf("写入 %s/index.html 失败: %w", projName, err) } fmt.Printf("Swagger 文档已生成: %s\n", moduleDir) } if err := generateSwaggerPortal(swaggerRoot); err != nil { return fmt.Errorf("生成导航页失败: %w", err) } return nil } func generateSwaggerPortal(swaggerRoot string) error { entries, err := os.ReadDir(swaggerRoot) if err != nil { return err } var modules []struct{ Name, Title string } for _, e := range entries { if !e.IsDir() { continue } specPath := filepath.Join(swaggerRoot, e.Name(), "api-spec.json") title := e.Name() if data, err := os.ReadFile(specPath); err == nil { var spec map[string]interface{} if json.Unmarshal(data, &spec) == nil { if t, ok := spec["title"].(string); ok && t != "" { title = t } } } modules = append(modules, struct{ Name, Title string }{e.Name(), title}) } sort.Slice(modules, func(i, j int) bool { return modules[i].Name < modules[j].Name }) html := swaggerPortalHTML(modules) return os.WriteFile(filepath.Join(swaggerRoot, "index.html"), []byte(html), os.ModePerm) } func swaggerPortalHTML(modules []struct{ Name, Title string }) string { var cards string for _, m := range modules { cards += `
` + strings.ToUpper(m.Name[:1]) + m.Name[1:] + `
` + m.Title + `
` + m.Name + `/
` } return ` API 文档中心

API 文档中心

选择一个模块查看接口文档与调试控制台
` + cards + `
` } func apiConsoleHTML() string { return ` API 调试控制台

← 选择一个接口开始
` } func inferSchema(v interface{}) map[string]interface{} { if v == nil { return map[string]interface{}{"type": "string"} } switch v.(type) { case int, int64, int32, float64, float32: return map[string]interface{}{"type": "number"} case bool: return map[string]interface{}{"type": "boolean"} case map[string]interface{}, Map: props := map[string]interface{}{} var m map[string]interface{} switch val := v.(type) { case Map: m = map[string]interface{}(val) case map[string]interface{}: m = val } for k, val := range m { props[k] = inferSchema(val) } return map[string]interface{}{"type": "object", "properties": props} default: return map[string]interface{}{"type": "string"} } }