Scala HTTP 客户端使用与技术文档

1. 安装指南

1.1 在 sbt 中添加依赖

在 build.sbt 文件中添加以下依赖项：

libraryDependencies += "org.scalaj" %% "scalaj-http" % "2.4.2"

1.2 在 Maven 中添加依赖

在 Maven 的 pom.xml 文件中添加以下依赖项：

<dependency>
  <groupId>org.scalaj</groupId>
  <artifactId>scalaj-http_${scala.version}</artifactId>
  <version>2.4.2</version>
</dependency>

如果您的项目是一个公共库，建议更改完整限定名以避免版本冲突。

2. 项目的使用说明

本项目是一个 Scala HTTP 客户端，为零依赖，支持跨编译 Scala 2.10、2.11、2.12 和 2.13-M3 版本。它具有 OAuth v1 请求签名、自动支持服务器端的 gzip 和 deflate 编码、易于添加查询字符串或表单参数等功能。

2.1 简单 GET 请求

import scalaj.http._

val response: HttpResponse[String] = Http("http://foo.com/search").param("q", "monkeys").asString
println(response.body)
println(response.code)
println(response.headers)
println(response.cookies)

2.2 不变请求

可以通过创建 HttpRequest 实例并重用它：

val request: HttpRequest = Http("http://date.jsontest.com/")

val responseOne = request.asString
val responseTwo = request.asString

2.3 简单表单编码 POST 请求

Http("http://foo.com/add").postForm(Seq("name" -> "jon", "age" -> "29")).asString

2.4 OAuth v1 舞蹈与请求

请注意，.oauth(...) 调用必须是请求构造中的最后一个方法。

import scalaj.http.{Http, Token}

val consumer = Token("key", "secret")
val response = Http("https://api.twitter.com/oauth/request_token").postForm(Seq("oauth_callback" -> "oob"))
  .oauth(consumer).asToken

println("访问 https://api.twitter.com/oauth/authorize?oauth_token=" + response.body.key)

val verifier = Console.readLine("输入验证码: ").trim

val accessToken = Http("https://api.twitter.com/oauth/access_token").postForm.
  .oauth(consumer, response.body, verifier).asToken

println(Http("https://api.twitter.com/1.1/account/settings.json").oauth(consumer, accessToken.body).asString)

3. 项目API使用文档

更多 API 使用文档，请参考 scaladocs。

4. 项目安装方式

请参考上述的安装指南部分，您可以通过 sbt 或 Maven 添加项目依赖。如果需要将源代码复制到项目中，本项目仅有四个文件，无任何依赖，可以直接复制并使用。

请注意，此项目已被弃用，推荐使用 sttp 或 http4s 等其他支持库进行 HTTP 调用。如果您的代码库继承使用了此库，建议直接复制源代码并进行必要的修改。