platform/io.sc.platform.developer.doc/asciidoc/9999-appendix/tools/curl/curl.adoc

= curl
curl 是常用的命令行工具，用来请求 Web 服务器。它的名字就是客户端（client）的 URL 工具的意思。

它的功能非常强大，命令行参数多达几十种。如果熟练的话，完全可以取代 Postman 这一类的图形界面工具。

不带有任何参数时，curl 就是发出 GET 请求。
[source,bash]
----
# 向 www.example.com 发出 GET 请求，服务器返回的内容会在命令行输出。
curl https://www.example.com
----

== -A
-A 参数指定客户端的用户代理标头，即 User-Agent。curl 的默认用户代理字符串是curl/[version]。
[source,bash]
----
# 将 User-Agent 改成 Chrome 浏览器
curl -A 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/76.0.3809.100 Safari/537.36' https://google.com

# 移除 User-Agent 标头
curl -A '' https://google.com

# 通过 -H 参数直接指定标头，更改 User-Agent
curl -H 'User-Agent: php/1.0' https://google.com
----

== -b
-b 参数用来向服务器发送 Cookie。
[source,bash]
----
# 生成一个标头 Cookie: foo=bar，向服务器发送一个名为 foo、值为 bar 的 Cookie
curl -b 'foo=bar' https://google.com

# 发送两个 Cookie
curl -b 'foo1=bar;foo2=bar2' https://google.com

# 读取本地文件 cookies.txt，里面是服务器设置的 Cookie（参见-c参数），将其发送到服务器
curl -b cookies.txt https://www.google.com
----

== -c
-c 参数将服务器设置的 Cookie 写入一个文件。
[source,bash]
----
# 将服务器的 HTTP 回应所设置 Cookie 写入文本文件 cookies.txt
curl -c cookies.txt https://www.google.com
----

== -d
-d 参数用于发送 POST 请求的数据体。
[source,bash]
----
# 使用 -d 参数以后，HTTP 请求会自动加上标头Content-Type : application/x-www-form-urlencoded。
# 并且会自动将请求转为 POST 方法，因此可以省略 -X POST
curl -d'login=emma＆password=123'-X POST https://google.com/login
# 或者
curl -d 'login=emma' -d 'password=123' -X POST  https://google.com/login

# 读取本地文本文件的数据，向服务器发送
curl -d '@data.txt' https://google.com/login
----

== --data-urlencode
--data-urlencode 参数等同于 -d，发送 POST 请求的数据体，区别在于会自动将发送的数据进行 URL 编码。
[source,bash]
----
# 发送的数据 hello world 之间有一个空格，需要进行 URL 编码
curl --data-urlencode 'comment=hello world' https://google.com/login
----

== -e
-e 参数用来设置 HTTP 的标头 Referer，表示请求的来源。
[source,bash]
----
# 将 Referer 标头设为 https://google.com?q=example
curl -e 'https://google.com?q=example' https://www.example.com

# -H 参数可以通过直接添加标头 Referer，达到同样效果
curl -H 'Referer: https://google.com?q=example' https://www.example.com
----

== -F
-F 参数用来向服务器上传二进制文件。
[source,bash]
----
# 会给 HTTP 请求加上标头 Content-Type: multipart/form-data，然后将文件 photo.png 作为 file 字段上传
curl -F 'file=@photo.png' https://google.com/profile

# 指定 MIME 类型，否则 curl 会把 MIME 类型设为 application/octet-stream
curl -F 'file=@photo.png;type=image/png' https://google.com/profile

# 原始文件名为 photo.png，但是服务器接收到的文件名为 me.png
curl -F 'file=@photo.png;filename=me.png' https://google.com/profile
----
== -G
-G 参数用来构造 URL 的查询字符串。
[source,bash]
----
# 发出一个 GET 请求，实际请求的 URL 为 https://google.com/search?q=kitties&count=20。如果省略 -G，会发出一个 POST 请求
curl -G -d 'q=kitties' -d 'count=20' https://google.com/search

# 如果数据需要 URL 编码，可以结合 --data--urlencode 参数
curl -G --data-urlencode 'comment=hello world' https://www.example.com
----

== -H
-H 参数添加 HTTP 请求的标头。
[source,bash]
----
# 添加 HTTP 标头 Accept-Language: en-US
curl -H 'Accept-Language: en-US' https://google.com

# 添加两个 HTTP 标头
curl -H 'Accept-Language: en-US' -H 'Secret-Message: xyzzy' https://google.com

# 添加 HTTP 请求的标头是 Content-Type: application/json，然后用 -d 参数发送 JSON 数据
curl -d '{"login": "emma", "pass": "123"}' -H 'Content-Type: application/json' https://google.com/login
----

== -i
-i 参数打印出服务器回应的 HTTP 标头。
[source,bash]
----
# 收到服务器回应后，先输出服务器回应的标头，然后空一行，再输出网页的源码
curl -i https://www.example.com
----

== -I
-I 参数向服务器发出 HEAD 请求，然会将服务器返回的 HTTP 标头打印出来。
[source,bash]
----
# 输出服务器对 HEAD 请求的回应
curl -I https://www.example.com

# --head 参数等同于 -I
curl --head https://www.example.com
----

== -k
-k 参数指定跳过 SSL 检测。
[source,bash]
----
# 不会检查服务器的 SSL 证书是否正确
curl -k https://www.example.com
----

== -L
-L 参数会让 HTTP 请求跟随服务器的重定向。curl 默认不跟随重定向。
[source,bash]
----
curl -L -d 'tweet=hi' https://api.twitter.com/tweet
----

== --limit-rate
--limit-rate 用来限制 HTTP 请求和回应的带宽，模拟慢网速的环境。
[source,bash]
----
# 将带宽限制在每秒 200K 字节
curl --limit-rate 200k https://google.com
----

== -o
-o 参数将服务器的回应保存成文件，等同于 wget 命令。
[source,bash]
----
# www.example.com 保存成 example.html
curl -o example.html https://www.example.com
----

== -O
-O 参数将服务器回应保存成文件，并将 URL 的最后部分当作文件名。
[source,bash]
----
# 将服务器回应保存成文件，文件名为 bar.html
curl -O https://www.example.com/foo/bar.html
----

== -s
-s 参数将不输出错误和进度信息。

[source,bash]
----
# 一旦发生错误，不会显示错误信息。不发生错误的话，会正常显示运行结果
curl -s https://www.example.com

# 如果想让 curl 不产生任何输出，可以使用下面的命令。
curl -s -o /dev/null https://google.com
----

== -S
-S 参数指定只输出错误信息，通常与 -s 一起使用。
[source,bash]
----
# 没有任何输出，除非发生错误
curl -s -o /dev/null https://google.com
----

== -u
-u 参数用来设置服务器认证的用户名和密码。
[source,bash]
----
# 设置用户名为 bob，密码为 12345，然后将其转为 HTTP 标头 Authorization: Basic Ym9iOjEyMzQ1
curl -u 'bob:12345' https://google.com/login

# 自动识别 URL 里面的用户名和密码，将其转为上个例子里面的 HTTP 标头
curl https://bob:12345@google.com/login

# 只设置了用户名，执行后，curl 会提示用户输入密码
curl -u 'bob' https://google.com/login
----

== -v
-v 参数输出通信的整个过程，用于调试。
[source,bash]
----
curl -v https://www.example.com

# --trace 参数也可以用于调试，还会输出原始的二进制数据
curl --trace - https://www.example.com
----

== -x
-x 参数指定 HTTP 请求的代理。
[source,bash]
----
# 指定 HTTP 请求通过 myproxy.com:8080 的 socks5 代理发出
curl -x socks5://james:cats@myproxy.com:8080 https://www.example.com

# 如果没有指定代理协议，默认为 HTTP。
curl -x james:cats@myproxy.com:8080 https://www.example.com
----

== -X
-X 参数指定 HTTP 请求的方法。
[source,bash]
----
# 对 https://www.example.com 发出 POST 请求
curl -X POST https://www.example.com
----