docs(README): 更新文档为中文并完善API参考

- 将README从英文翻译为中文
- 添加详细的API参考文档,包括所有管理接口和枚举值说明
- 补充安装、快速开始、认证方式等使用指南

refactor(client): 优化客户端代码结构并添加详细注释

- 为所有API方法添加中文注释和使用说明
- 改进Client结构体和Option配置的设计
- 统一错误处理和响应结构的文档说明
This commit is contained in:
shiran
2026-04-18 15:54:19 +08:00
parent fe19922eff
commit fe43b9bdce
15 changed files with 1013 additions and 291 deletions
+13
View File
@@ -5,6 +5,15 @@ import (
"net/url"
)
// buildQuery 将 map[string]interface{} 转成 url.Values。
//
// 规则:
// - nil / 空字符串 / 值为 0 的 int/uint 会被忽略(视作未传)
// - int8 不做零值过滤(因为 0 可能是合法的状态值,如 Status=0 禁用)
// - 指针类型 (*int / *int8 / *uint) 为 nil 时忽略,否则取值写入
// - 其它类型走 fmt.Sprintf("%v") 兜底
//
// 这种设计允许调用方使用零值(空字符串 / 0)来表达"该过滤项不设置"。
func buildQuery(params map[string]interface{}) url.Values {
q := url.Values{}
for k, v := range params {
@@ -45,6 +54,8 @@ func buildQuery(params map[string]interface{}) url.Values {
return q
}
// paginationParams 将分页结构体转换为通用 map 形式的查询参数,
// 供 mergeParams 与 buildQuery 继续拼装。Page / PageSize <=0 时会被忽略。
func paginationParams(p PaginationQuery) map[string]interface{} {
m := map[string]interface{}{}
if p.Page > 0 {
@@ -56,6 +67,8 @@ func paginationParams(p PaginationQuery) map[string]interface{} {
return m
}
// mergeParams 合并多个查询参数 map,后者覆盖前者。
// 用于把分页参数与业务过滤参数拼在一起传给 buildQuery。
func mergeParams(maps ...map[string]interface{}) map[string]interface{} {
result := map[string]interface{}{}
for _, m := range maps {