docs

type APIDocGenerator struct {
	// contains filtered or unexported fields
}

type APIDocumentation struct {
	// 文档标题
	Title string `json:"title"`

	// 文档描述
	Description string `json:"description"`

	// API版本
	Version string `json:"version"`

	// 基础URL
	BaseURL string `json:"base_url"`

	// 生成时间
	GeneratedAt time.Time `json:"generated_at"`

	// 作者
	Author string `json:"author,omitempty"`

	// 联系邮箱
	Email string `json:"email,omitempty"`

	// 许可证
	License string `json:"license,omitempty"`

	// API端点列表
	Endpoints []APIEndpoint `json:"endpoints"`

	// 模型定义
	Models map[string]interface{} `json:"models,omitempty"`
}

type APIEndpoint struct {
	// 端点路径
	Path string `json:"path"`

	// HTTP方法
	Method string `json:"method"`

	// 端点描述
	Description string `json:"description"`

	// 处理器函数名称
	Handler string `json:"handler"`

	// 请求参数
	RequestParams []APIParam `json:"request_params,omitempty"`

	// 请求体
	RequestBody interface{} `json:"request_body,omitempty"`

	// 响应体
	ResponseBody interface{} `json:"response_body,omitempty"`

	// 可能的响应状态码
	StatusCodes []APIStatusCode `json:"status_codes,omitempty"`

	// 中间件
	Middleware []string `json:"middleware,omitempty"`

	// 分组名
	Group string `json:"group,omitempty"`

	// 端点标签（用于分类）
	Tags []string `json:"tags,omitempty"`

	// 是否废弃
	Deprecated bool `json:"deprecated,omitempty"`

	// 废弃说明
	DeprecationMessage string `json:"deprecation_message,omitempty"`

	// 示例请求
	Examples []APIExample `json:"examples,omitempty"`
}

type APIExample struct {
	// 示例名称
	Name string `json:"name"`

	// 示例请求
	Request interface{} `json:"request"`

	// 示例响应
	Response interface{} `json:"response"`

	// 示例描述
	Description string `json:"description,omitempty"`
}

type APIParam struct {
	// 参数名
	Name string `json:"name"`

	// 参数类型
	Type string `json:"type"`

	// 参数描述
	Description string `json:"description"`

	// 是否必需
	Required bool `json:"required"`

	// 默认值
	DefaultValue string `json:"default_value,omitempty"`

	// 参数位置（路径、查询、头部、正文等）
	Location string `json:"location"`

	// 验证规则
	ValidationRules string `json:"validation_rules,omitempty"`

	// 示例值
	Example string `json:"example,omitempty"`
}

type APIStatusCode struct {
	// HTTP状态码
	Code int `json:"code"`

	// 状态描述
	Description string `json:"description"`

	// 示例响应
	Example interface{} `json:"example,omitempty"`
}

type CLIDocGenerator struct {
	// contains filtered or unexported fields
}

type ConfigDocGenerator struct {
	// contains filtered or unexported fields
}

type DatabaseDocGenerator struct {
	// contains filtered or unexported fields
}

type DocumentationGenerator struct {
	// contains filtered or unexported fields
}

type FieldDefinition struct {
	// 字段名
	Name string `json:"name"`

	// 字段描述
	Description string `json:"description,omitempty"`

	// 字段类型
	Type string `json:"type"`

	// 字段标签
	Tags map[string]string `json:"tags,omitempty"`

	// 是否为主键
	PrimaryKey bool `json:"primary_key,omitempty"`

	// 是否必需
	Required bool `json:"required,omitempty"`

	// 字段默认值
	DefaultValue string `json:"default_value,omitempty"`

	// 是否可为空
	Nullable bool `json:"nullable,omitempty"`

	// 字段注释
	Comment string `json:"comment,omitempty"`

	// 字段验证规则
	ValidationRules string `json:"validation_rules,omitempty"`

	// 字段索引名（如果是索引）
	IndexName string `json:"index_name,omitempty"`

	// 是否唯一
	Unique bool `json:"unique,omitempty"`

	// 关联模型（如果是外键）
	RelatedModel string `json:"related_model,omitempty"`

	// 关联字段（如果是外键）
	RelatedField string `json:"related_field,omitempty"`

	// 字段示例值
	Example string `json:"example,omitempty"`
}

type Generator interface {
	// Generate 生成文档
	Generate() error
}

type ModelDefinition struct {
	// 模型名称
	Name string `json:"name"`

	// 模型描述
	Description string `json:"description"`

	// 模型注释
	Comment string `json:"comment,omitempty"`

	// 模型所在包路径
	Package string `json:"package"`

	// 对应的数据库表（如果有）
	Table string `json:"table,omitempty"`

	// 字段定义
	Fields []FieldDefinition `json:"fields"`
}

type ModelDoc struct {
	// 文档标题
	Title string `json:"title"`

	// 文档描述
	Description string `json:"description"`

	// 生成时间
	GeneratedAt time.Time `json:"generated_at"`

	// 模型定义
	Models []ModelDefinition `json:"models"`

	// 关系定义
	Relationships []Relationship `json:"relationships,omitempty"`
}

type ModelDocGenerator struct {
	// contains filtered or unexported fields
}

type ModuleDocGenerator struct {
	// contains filtered or unexported fields
}

type Relationship struct {
	// 源模型
	Source string `json:"source"`

	// 目标模型
	Target string `json:"target"`

	// 关系类型（一对一、一对多、多对多）
	Type string `json:"type"`

	// 源字段
	SourceField string `json:"source_field"`

	// 目标字段
	TargetField string `json:"target_field"`

	// 关系描述
	Description string `json:"description,omitempty"`

	// 中间表（如果是多对多关系）
	JoinTable string `json:"join_table,omitempty"`
}

type SwaggerContact struct {
	Name  string `json:"name,omitempty"`
	URL   string `json:"url,omitempty"`
	Email string `json:"email,omitempty"`
}

type SwaggerDocument struct {
	Swagger             string                 `json:"swagger"`
	Info                SwaggerInfo            `json:"info"`
	Host                string                 `json:"host,omitempty"`
	BasePath            string                 `json:"basePath,omitempty"`
	Schemes             []string               `json:"schemes,omitempty"`
	Paths               map[string]interface{} `json:"paths"`
	Definitions         map[string]interface{} `json:"definitions,omitempty"`
	SecurityDefinitions map[string]interface{} `json:"securityDefinitions,omitempty"`
	Tags                []SwaggerTag           `json:"tags,omitempty"`
}

type SwaggerGenerator struct {
	// contains filtered or unexported fields
}

type SwaggerInfo struct {
	Title       string          `json:"title"`
	Description string          `json:"description"`
	Version     string          `json:"version"`
	Contact     *SwaggerContact `json:"contact,omitempty"`
	License     *SwaggerLicense `json:"license,omitempty"`
}

type SwaggerLicense struct {
	Name string `json:"name"`
	URL  string `json:"url,omitempty"`
}

type SwaggerTag struct {
	Name        string `json:"name"`
	Description string `json:"description,omitempty"`
}