api-doc/define/generate.go

49 lines
1.5 KiB
Go

// Package define ...
//
// Description : define ...
//
// Author : go_developer@163.com<白茶清欢>
//
// Date : 2024-08-14 15:20
package define
// UriBaseConfig 添加接口时的基础配置
//
// Author : go_developer@163.com<白茶清欢>
//
// Date : 15:21 2024/8/14
type UriBaseConfig struct {
Uri string `json:"uri"` // 接口路由
Method string `json:"method"` // 接口请求方法
ContentType string `json:"content_type"` // 接口请求类型
TagList []string `json:"tag_list"` // 接口标签列表
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"` // 返回值描述
}