diff --git a/define/generate.go b/define/generate.go index daf934e..aa97da3 100644 --- a/define/generate.go +++ b/define/generate.go @@ -20,3 +20,29 @@ type UriBaseConfig struct { Summary string `json:"summary"` // 接口摘要描述 Description string `json:"description"` // 接口详细描述 } + +// ParamConfig 参数配置 +// +// Author : go_developer@163.com<白茶清欢> +// +// Date : 16:23 2024/8/19 +type ParamConfig struct { + Location string `json:"location"` // 参数位置 + Path string `json:"path"` // 参数路径 + Type string `json:"type"` // 参数类型 + Title string `json:"title"` // 参数标题 + Description string `json:"description"` // 参数描述 +} + +// ResultConfig 返回值配置 +// +// Author : go_developer@163.com<白茶清欢> +// +// Date : 16:23 2024/8/19 +type ResultConfig struct { + Location string `json:"location"` // 返回值位置 + Path string `json:"path"` // 返回值路径 + Type string `json:"type"` // 返回值类型 + Title string `json:"title"` // 返回值标题 + Description string `json:"description"` // 返回值描述 +} diff --git a/generate.go b/generate.go index ab31b09..5b60bea 100644 --- a/generate.go +++ b/generate.go @@ -10,7 +10,6 @@ package api_doc import ( "git.zhangdeman.cn/gateway/api-doc/define" "git.zhangdeman.cn/zhangdeman/consts" - "reflect" "strings" ) @@ -156,14 +155,10 @@ type PathItemOperationConfig struct { // Description: "这是一份示例基础配置", // } // -// parameterPtr : 请求表单结构体实例, 必须为指针, 作用 -> 基于反射生成参数文档 +// paramList : 参数列表 // -// resultPtr : 返回值结构体实例, 必须为指针, 作用 -> 基于反射生成返回值文档 -func (g *Generate) AddApi(baseCfg *define.UriBaseConfig, parameterPtr any, resultPtr any) error { - paramType := reflect.TypeOf(parameterPtr) - for idx := 0; idx < paramType.NumField(); idx++ { +// resultList : 返回值列表 +func (g *Generate) AddApi(baseCfg *define.UriBaseConfig, paramList []*define.ParamConfig, resultList []*define.ResultConfig) error { - } - resultType := reflect.TypeOf(resultPtr) return nil }