Typhoeus 项目技术文档

1. 安装指南

Typhoeus 是一个 Ruby 库，可以通过以下两种方式安装：

• 使用 Bundler，在项目 Gemfile 中添加 gem 'typhoeus'，然后执行 bundle install。
• 直接使用 RubyGems 安装，执行命令 gem install typhoeus。

确保你的环境中已经安装了 Ruby。

2. 项目使用说明

Typhoeus 提供了一个简洁的 API，用于执行 HTTP 请求。主要接口包括三种类型：Request、Response 和 Hydra。

Request

创建一个请求对象，可以指定 URL 和一系列可选参数。

request = Typhoeus::Request.new(
  "www.example.com",
  method: :post,
  body: "this is a request body",
  params: { field1: "a field" },
  headers: { Accept: "text/html" }
)

Response

请求完成后，可以通过 Response 对象访问响应数据。

response = request.run
response.code
response.total_time
response.headers
response.body

Hydra

Hydra 允许并行执行多个请求。

hydra = Typhoeus::Hydra.new
hydra.queue(request)
hydra.run

3. 项目API使用文档

Typhoeus 的 API 文档可以在 GitHub 上找到。下面是一些基本的使用示例：

发送请求

• GET 请求：

Typhoeus.get("www.example.com")

• POST 请求：

Typhoeus.post("www.example.com", body: { key: "value" })

• 其他 HTTP 方法：

Typhoeus.put("www.example.com/resource", body: { key: "value" })
Typhoeus.delete("www.example.com/resource")
# 等

并发请求

hydra = Typhoeus::Hydra.new
10.times.map{ hydra.queue(Typhoeus::Request.new("www.example.com")) }
hydra.run

处理响应

request.on_complete do |response|
  if response.success?
    # 成功处理
  else
    # 错误处理
  end
end

文件上传

Typhoeus.post(
  "http://localhost:3000/posts",
  body: {
    file: File.open("thesis.txt", "r")
  }
)

流式响应

request.on_body do |chunk|
  # 处理数据块
end

4. 项目安装方式

请参考安装指南部分，可以使用 Bundler 或 RubyGems 进行安装。