csxj2026/junhong_cmp_fiber
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects 1 Releases Wiki Activity

文档生成

Browse Source
This commit is contained in:
huang
2026-05-11 11:59:36 +08:00
parent 98ff88d5c3
commit b6d21b81e3
4 changed files with 174 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
internal/routes/registry.go
View File

@@ -17,14 +17,15 @@ type FileUploadField struct {
// RouteSpec 定义接口文档元数据
type RouteSpec struct {
Summary string // 简短摘要（中文，一行）
Description string // 详细说明，支持 Markdown 语法（可选）
Input interface{} // 请求参数结构体 (Query/Path/Body)
Body interface{} // 显式 JSON 请求体（用于 DELETE 等方法，库不自动生成 requestBody 的场景）
Output interface{} // 响应参数结构体
Tags []string // 分类标签
Auth bool // 是否需要认证图标 (预留)
FileUploads []FileUploadField // 文件上传字段列表（设置此字段时请求类型为 multipart/form-data）
Summary string // 简短摘要（中文，一行）
Description string // 详细说明，支持 Markdown 语法（可选）
Input interface{} // 请求参数结构体 (Query/Path/Body)
Body interface{} // 显式 JSON 请求体（用于 DELETE 等方法，库不自动生成 requestBody 的场景）
Output interface{} // 响应参数结构体
Tags []string // 分类标签
Auth bool // 是否需要认证响应和认证标记
SecurityScheme string // OpenAPI 认证方案，空值表示 BearerAuth
FileUploads []FileUploadField // 文件上传字段列表（设置此字段时请求类型为 multipart/form-data）
}
// pathParamRegex 用于匹配 Fiber 的路径参数格式 /:param
@@ -55,7 +56,7 @@ func Register(router fiber.Router, doc *openapi.Generator, basePath, method, pat
}
doc.AddMultipartOperation(method, openapiPath, spec.Summary, spec.Description, spec.Input, spec.Output, spec.Auth, fileFields, spec.Tags...)
} else {
doc.AddOperation(method, openapiPath, spec.Summary, spec.Description, spec.Input, spec.Body, spec.Output, spec.Auth, spec.Tags...)
doc.AddOperationWithSecurity(method, openapiPath, spec.Summary, spec.Description, spec.Input, spec.Body, spec.Output, spec.Auth, spec.SecurityScheme, spec.Tags...)
}
}
}