Multipart::Post 技术文档

1. 安装指南

首先，您需要在项目中添加 Multipart::Post 库。使用以下命令将其添加到您的项目依赖中：

bundle add multipart-post

确保已经安装了 bundler，然后执行上述命令，这会将 multipart-post 库及其依赖项添加到您的项目 Gemfile 中。

2. 项目的使用说明

Multipart::Post 库为 Net::HTTP 添加了流式多部分表单 POST 功能，并支持除 POST 之外的其他方法。以下是一个简单的使用例子：

require 'net/http/post/multipart'

url = URI.parse('http://www.example.com/upload')
File.open("./image.jpg") do |jpg|
  req = Net::HTTP::Post::Multipart.new url.path,
    "file" => UploadIO.new(jpg, "image/jpeg", "image.jpg")
  res = Net::HTTP.start(url.host, url.port) do |http|
    http.request(req)
  end
end

此代码段将一个名为 "file" 的文件上传到指定的 URL。

3. 项目API使用文档

Multipart::Post 提供了 UploadIO 辅助类，以准备包含在多部分 POST 对象的参数哈希中的 IO 对象。

以下是如何使用 API 来发送多个文件和其他参数的例子：

require 'net/http/post/multipart'

url = URI.parse('http://www.example.com/upload')
req = Net::HTTP::Post::Multipart.new url.path,
  "file1" => UploadIO.new(File.new("./image.jpg"), "image/jpeg", "image.jpg"),
  "file2" => UploadIO.new(File.new("./image2.jpg"), "image/jpeg", "image2.jpg"),
  "description" => "这是两张图片的描述"

res = Net::HTTP.start(url.host, url.port) do |http|
  http.request(req)
end

在上述代码中，file1 和 file2 是上传的文件，description 是一个普通的表单参数。

自定义部分头部

可以为文件部分添加自定义头部。以下是如何添加自定义头部的例子：

headers = {
  'parts': {
    'file1': {
      'Content-Type' => "image/jpeg",
      'My-Custom-Header' => "自定义值"
    }
  }
}

req = Net::HTTP::Post::Multipart.new(url, params, headers)

4. 项目安装方式

Multipart::Post 库的安装方式已在“安装指南”一节中详细说明。您只需运行以下命令即可安装：

bundle add multipart-post

然后，确保在您的 Ruby 项目中引入了所需的库，并按照上述使用说明进行操作。