go-base/sdk/configure/doc.go

// Package configure 提供配置中心客户端的SDK，支持数据库字典和别名字典的增删改查操作。
//
// 主要功能：
//   - 数据库表字典的创建、查询、更新、删除
//   - 数据库表别名和字段别名字典管理
//   - 别名审批工作流管理
//   - 支持Basic认证和Token认证
//   - 自动从全局配置加载配置中心地址和token
//   - 完整的错误处理和类型安全
//
// 快速开始：
//
//	// 使用默认配置（从全局config获取）
//	client, err := configure.NewClient()
//	if err != nil {
//	    log.Fatal(err)
//	}
//
//	// 查询数据库表字典列表
//	query := &configure.DicTableQueryRequest{
//	    QueryRequest: queryreq.QueryRequest{
//	        Page:     0,
//	        PageSize: 10,
//	    },
//	}
//
//	result, err := client.ListTables(context.Background(), query)
//	if err != nil {
//	    log.Fatal(err)
//	}
//
//	// 创建数据库表字典
//	req := &configure.DicTableRequest{
//	    TableID:     "test_table_001",
//	    TableType:   "实体表",
//	    Name:        "测试表",
//	    Description: "测试表描述",
//	    Fields: []configure.DicTableFieldRequest{
//	        {
//	            FieldID:     "test_table_001.id",
//	            TableID:     "test_table_001",
//	            FiledType:   "实际字段",
//	            DataType:    "数值型",
//	            FieldName:   "id",
//	            FieldNameCN: "主键ID",
//	            Description: "主键字段",
//	        },
//	    },
//	}
//
//	detail, err := client.SaveTable(context.Background(), req)
//	if err != nil {
//	    log.Fatal(err)
//	}
//
// 配置说明：
//
// 客户端支持两种认证方式：
//   - Basic认证：使用用户名和密码
//   - Token认证：使用Bearer token
//
// 配置可以从以下方式获取：
//   - 全局配置：通过config.GetConfigureConfig()获取配置中心地址和token
//   - 自定义配置：通过NewClientWithConfig()传入自定义配置
//
// API端点：
//   - POST /api/dic-table/list     - 查询数据库表字典列表
//   - POST /api/dic-table/detail/{table_id} - 查询数据库表字典详情
//   - POST /api/dic-table/save     - 创建或更新数据库表字典
//   - POST /api/dic-table/delete/{table_id} - 删除数据库表字典
//
// 别名管理API端点：
//   - POST /api/dic-table-alias/list     - 查询表别名字典列表
//   - POST /api/dic-table-alias/detail/{id} - 查询表别名字典详情
//   - POST /api/dic-table-alias/save     - 保存表别名字典
//   - POST /api/dic-table-alias/batch-save - 批量保存表别名字典
//   - POST /api/dic-table-alias/delete/{id} - 删除表别名字典
//   - POST /api/dic-table-field-alias/list     - 查询字段别名字典列表
//   - POST /api/dic-table-field-alias/detail/{id} - 查询字段别名字典详情
//   - POST /api/dic-table-field-alias/save     - 保存字段别名字典
//   - POST /api/dic-table-field-alias/batch-save - 批量保存字段别名字典
//   - POST /api/dic-table-field-alias/delete/{id} - 删除字段别名字典
//   - POST /api/dic-table-alias-flow/list     - 查询表别名字典流水列表
//   - POST /api/dic-table-alias-flow/batch-save - 批量保存表别名字典流水
//   - POST /api/dic-table-alias-flow/batch-approval - 批量审批表别名字典流水
//   - POST /api/dic-table-field-alias-flow/list     - 查询字段别名字典流水列表
//   - POST /api/dic-table-field-alias-flow/batch-save - 批量保存字段别名字典流水
//   - POST /api/dic-table-field-alias-flow/batch-approval - 批量审批字段别名字典流水
package configure