RenderAPI

最新更新

主要特性

安装

go get github.com/birdmichael/RenderAPI

基本用法

package main
import (
	"fmt"
	"github.com/birdmichael/RenderAPI/pkg/client"
	"github.com/birdmichael/RenderAPI/pkg/hooks"
)
func main() {
	// 创建 HTTP 客户端
	c := client.NewClient("https://api.example.com", 10)
	
	// 添加认证令牌
	c.SetHeader("Authorization", "Bearer your-token")
	
	// 添加请求日志钩子
	c.AddBeforeRequestHook(hooks.LoggingHook)
	
	// 发送 GET 请求
	resp, err := c.Get("/users")
	if err != nil {
		fmt.Printf("请求失败: %v\n", err)
		return
	}
	
	// 读取响应
	body, err := client.ReadResponseBody(resp)
	if err != nil {
		fmt.Printf("读取响应失败: %v\n", err)
		return
	}
	
	fmt.Println(string(body))
}

使用 JSON 模板

package main
import (
	"fmt"
	"github.com/birdmichael/RenderAPI/pkg/client"
)
func main() {
	c := client.NewClient("https://api.example.com", 10)
	
	// 定义 JSON 模板
	template := `{
		"user": {
			"name": "{{.name}}",
			"age": {{.age}},
			"email": "{{.email}}"
		}
	}`
	
	// 准备数据
	data := map[string]interface{}{
		"name": "张三",
		"age": 30,
		"email": "zhangsan@example.com",
	}
	
	// 发送带有模板的 POST 请求
	resp, err := c.PostWithTemplate("/users", template, data)
	if err != nil {
		fmt.Printf("请求失败: %v\n", err)
		return
	}
	
	// 处理响应...
}

使用文件模板和数据

package main
import (
	"fmt"
	"github.com/birdmichael/RenderAPI/pkg/client"
)
func main() {
	c := client.NewClient("https://api.example.com", 10)
	
	// 使用文件模板和数据文件发送请求
	resp, err := c.PostWithTemplateFile("/users", "templates/user.json", "data/user_data.json")
	if err != nil {
		fmt.Printf("请求失败: %v\n", err)
		return
	}
	
	// 处理响应...
}

内置模板函数

字符串操作函数

日期时间函数

数学运算函数

数据转换函数

集合操作函数

条件逻辑函数

加密与编码函数

模板示例

基本数据处理

{
 "user": {
 "name": "{{ toUpper .name }}",
 "email": "{{ toLower .email }}",
 "registered_at": "{{ formatDateTime (now) }}",
 "is_active": {{ toBool .status }},
 "subscription": {
 "type": "{{ defaultValue .plan "free" }}",
 "expires_in_days": {{ div (toFloat .expires_seconds) 86400 }}
 }
 },
 "security": {
 "token_hash": "{{ sha256 .token }}",
 "login_ip": "{{ regexReplace "(\\d+)\\.(\\d+)\\.(\\d+)\\.(\\d+)" "1ドル.2ドル.XXX.XXX" .ip }}"
 }
}

条件逻辑

{
 "order": {
 "id": "{{ .order_id }}",
 "status": "{{ .status }}",
 "total": {{ .total }},
 "discount": {{ ternary (gt (toFloat .total) 1000) 0.15 0.05 }},
 "final_price": {{ sub (toFloat .total) (mul (toFloat .total) (ternary (gt (toFloat .total) 1000) 0.15 0.05)) }},
 "shipping": {
 "method": "{{ coalesce .shipping_method .default_shipping "standard" }}",
 "estimate_days": {{ ternary (eq .shipping_method "express") 1 (ternary (eq .shipping_method "priority") 3 7) }}
 }
 }
}

集合处理

{
 "analytics": {
 "total_items": {{ length .items }},
 "categories": {{ keys .categories }},
 "most_expensive": {{ last (slice (sort .prices) 0 (len .prices)) }},
 "average_price": {{ avg .prices }},
 "price_summary": {
 "min": {{ min (index .prices 0) (index .prices 1) }},
 "max": {{ max (index .prices 0) (index .prices 1) }}
 }
 },
 "highlighted_item": {{ jsonEncode (first .featured_items) }}
}

钩子系统

// 添加请求日志钩子
client.AddBeforeHook(&hooks.LoggingHook{})
// 添加认证钩子
client.AddBeforeHook(hooks.NewAuthHook("your-token"))
// 添加响应日志钩子
client.AddAfterHook(&hooks.ResponseLogHook{})
// 添加字段转换钩子
transformMap := map[string]string{
 "user": "phone" // 将 user 字段转换为 phone 字段
}
client.AddBeforeHook(hooks.NewFieldTransformHook(transformMap))
// 添加自定义钩子
client.AddBeforeHook(&hooks.CustomFunctionHook{
 BeforeFn: func(req *http.Request) (*http.Request, error) {
 req.Header.Set("X-Custom-Header", "value")
 return req, nil
 },
})

JavaScript脚本钩子

// 从文件加载JavaScript脚本钩子
if err := client.AddJSHookFromFile("scripts/transform_request.js", false, 30); err != nil {
 log.Fatalf("加载脚本失败: %v", err)
}
// 从字符串加载JavaScript脚本钩子
scriptContent := `
function processRequest(request) {
 // 修改请求体
 var body = JSON.parse(request.body);
 body.timestamp = new Date().toISOString();
 request.body = JSON.stringify(body);
 return request;
}
`
if err := client.AddJSHookFromString(scriptContent, false, 30); err != nil {
 log.Fatalf("添加脚本钩子失败: %v", err)
}

// scripts/transform_request.js
function processRequest(request) {
 // 读取请求体
 var body = JSON.parse(request.body);
 
 // 修改请求体
 if (body.user) {
 body.user.name = body.user.name.toUpperCase();
 body.user.created_at = new Date().toISOString();
 
 // 使用内置的RSA加密函数加密敏感信息
 if (body.user.password) {
 body.user.password = rsaEncryptGo(body.user.password, publicKey);
 }
 }
 
 // 返回修改后的请求体
 request.body = JSON.stringify(body);
 return request;
}

命令行钩子

// 添加命令行钩子(非异步,30秒超时)
client.AddCommandHook("jq '.user.name = .user.name | ascii_upcase'", false, 30)

模板定义中的钩子

{
 "request": {
 "method": "POST",
 "baseURL": "https://api.example.com",
 "path": "/users",
 "headers": {
 "Content-Type": "application/json"
 }
 },
 "beforeHooks": [
 {
 "type": "js",
 "name": "authHook",
 "script": "function processRequest(request) { console.log('Auth处理请求...'); return request; }",
 "async": false,
 "timeout": 10
 },
 {
 "type": "command",
 "name": "timestamp",
 "command": "jq '.body.timestamp = now'",
 "async": false,
 "timeout": 3
 }
 ],
 "afterHooks": [
 {
 "type": "js",
 "name": "postProcess",
 "script": "function processResponse(response) { console.log('后置处理响应...'); return response; }",
 "async": false,
 "timeout": 5
 }
 ],
 "body": {
 "user": {
 "name": "{{.name}}",
 "email": "{{.email}}"
 }
 }
}

缓存系统

{
 "request": {
 "method": "GET",
 "path": "/users/{{.user_id}}"
 },
 "caching": {
 "enabled": true,
 "ttl": 300,
 "keyPattern": "users-{{.user_id}}"
 }
}

重试机制

{
 "request": {
 "method": "POST",
 "path": "/process"
 },
 "retry": {
 "enabled": true,
 "maxAttempts": 3,
 "initialDelay": 1000,
 "backoffFactor": 2
 }
}

项目结构

RenderAPI/
├── cmd/ # 命令行工具
│ └── httpclient/ # HTTP客户端命令行工具
├── pkg/ # 核心包
│ ├── client/ # HTTP客户端实现
│ ├── template/ # 模板引擎
│ ├── hooks/ # 请求/响应钩子
│ │ ├── hooks.go # 钩子接口和通用功能
│ │ ├── custom_hook.go # 自定义钩子实现
│ │ ├── js_hook.go # JavaScript钩子实现
│ │ └── cmd_hook.go # 命令行钩子实现
│ └── config/ # 配置管理
├── examples/ # 使用示例
│ ├── basic/ # 基本使用示例
│ ├── advanced/ # 高级功能示例
│ └── template_file/ # 模板文件示例
├── testdata/ # 测试数据
└── internal/ # 内部工具和辅助函数
 └── utils/ # 工具函数

测试

# 运行所有测试
make test
# 生成测试覆盖率报告
make test-coverage
# 运行基准测试
make bench

使用场景

贡献

许可证