apidoc

type APIDoc struct {
	// API标题
	Title string `json:"title"`
	// API版本
	Version string `json:"version"`
	// API描述
	Description string `json:"description,omitempty"`
	// API分组
	Groups []GroupInfo `json:"groups,omitempty"`
	// API路由（不属于任何分组）
	Routes []RouteInfo `json:"routes,omitempty"`
	// contains filtered or unexported fields
}

type GroupInfo struct {
	// 分组名称
	Name string `json:"name"`
	// 分组前缀
	Prefix string `json:"prefix"`
	// 分组说明
	Description string `json:"description,omitempty"`
	// 分组下的路由
	Routes []RouteInfo `json:"routes"`
}

type ParamInfo struct {
	// 参数名
	Name string `json:"name"`
	// 参数位置 (path/query/header)
	In string `json:"in"`
	// 参数类型
	Type string `json:"type"`
	// 是否必需
	Required bool `json:"required"`
	// 参数描述
	Description string `json:"description,omitempty"`
}

type RouteInfo struct {
	// 请求方法
	Method string `json:"method"`
	// 路由路径
	Path string `json:"path"`
	// 路由说明
	Description string `json:"description,omitempty"`
	// 请求参数
	Params []ParamInfo `json:"params,omitempty"`
	// 请求体格式
	RequestBody interface{} `json:"request_body,omitempty"`
	// 响应格式
	ResponseBody interface{} `json:"response_body,omitempty"`
}