HTTPotion 技术文档

1. 安装指南

首先，您需要在项目的 mix.exs 文件中添加 HTTPotion 作为依赖：

defp deps do
  [
    {:httpotion, "~> 3.1.0"}
  ]
end

def application do
  [ applications: [:httpotion] ]
end

然后，通过以下命令获取项目依赖：

mix deps.get

2. 项目使用说明

HTTPotion 是一个基于 ibrowse 的 Elixir HTTP 客户端。以下是一些基本用法示例：

获取请求

response = HTTPotion.get "https://httpbin.org/get"

检查响应状态

HTTPotion.Response.success?(response)

访问响应头

response.headers[:sErvEr]
response.headers["ConTenT-TyPe"]

处理重定向

HTTPotion.get("https://httpbin.org/redirect-to?url=http%3A%2F%2Fexample.com%2F", follow_redirects: true)

发送表单数据

HTTPotion.post "https://httpbin.org/post", [body: "hello=" <> URI.encode_www_form("w o r l d !!"), headers: ["User-Agent": "My App", "Content-Type": "application/x-www-form-urlencoded"]]

发送基本认证

HTTPotion.get "https://httpbin.org/basic-auth/foo/bar", [basic_auth: {"foo", "bar"}]

自定义请求选项

HTTPotion.get "https://check-tls.akamaized.net", [ ibrowse: [ ssl_options: [ versions, [:'tlsv1.1'] ] ] ]

设置超时

HTTPotion.get "https://example.com", [timeout: 10_000]

错误处理

HTTPotion.get "http://localhost:1"
HTTPotion.get! "http://localhost:1"

3. 项目API使用文档

HTTPotion 提供了多种请求方法和选项，以下是一些常用选项：

• body: 请求的正文内容。
• headers: 请求的头部信息。
• query: 查询字符串。
• timeout: 超时时间（毫秒）。
• basic_auth: 基本认证凭证。
• stream_to: 用于异步请求的响应流。
• direct: 直接使用 ibrowse 工作进程。
• auto_sni: 是否自动配置 TLS SNI。
• follow_redirects: 是否跟随重定向。

更多选项和默认值，请参考项目的 README 文档。

4. 项目安装方式

请参考“安装指南”部分，简而言之，您需要在 mix.exs 文件中添加 HTTPotion 作为项目依赖，并运行 mix deps.get 命令来安装依赖。