想象一下,你需要在 CI/CD 流水線里發(fā)送一些 API 調(diào)用,以進(jìn)行身份驗(yàn)證、獲取數(shù)據(jù)、發(fā)送簡單請(qǐng)求或從網(wǎng)絡(luò) URI 下載文件。
你會(huì)選擇哪些工具?
答案可能是使用像 Postman 這樣的著名 API 測試工具。
不過一般情況下只需要用 curl 就夠了。而且很多年之前 curl 就已經(jīng)跨平臺(tái)了,我記得 windows 上也是可以使用的。
所以我認(rèn)為,寫一篇關(guān)于 CURL 的文章是值得的。
我將這篇文章的范圍縮小到 HTTP/HTTPS,因?yàn)閷懸黄P(guān)于 curl 全部功能的文章會(huì)花費(fèi)好幾天。你很快就會(huì)明白我為什么這么說。
curl 是做什么的?
Curl,全稱為“Client URL”,是一種命令行工具,用于通過 URL 傳輸數(shù)據(jù)。curl 還用于汽車、電視機(jī)、路由器、打印機(jī)、音頻設(shè)備、手機(jī)、平板電腦、醫(yī)療設(shè)備、機(jī)頂盒、電腦游戲、媒體播放器等。
Curl 是超過二百億個(gè)軟件應(yīng)用程序中的互聯(lián)網(wǎng)傳輸引擎。
幾乎每個(gè)使用互聯(lián)網(wǎng)的人每天都會(huì)使用 Curl。
你能想象它支持多少協(xié)議嗎?
DICT、FILE、FTP、FTPS、GOPHER、GOPHERS、HTTP、HTTPS、IMAP、IMAPS、LDAP、LDAPS、MQTT、POP3、POP3S、RTMP、RTMPS、RTSP、SCP、SFTP、SMB、SMBS、SMTP、SMTPS、TELNET、TFTP、WS 和 WSS。curl 支持 TLS 證書、HTTP POST、HTTP PUT、FTP 上傳、基于 HTTP 表單的上傳、代理(SOCKS4、SOCKS5、HTTP 和 HTTPS)、HTTP/2、HTTP/3、cookie、用戶+密碼認(rèn)證(Basic、Plain、Digest、CRAM-MD5、SCRAM-SHA、NTLM、Negotiate、Kerberos、Bearer tokens 和 AWS Sigv4)、文件傳輸恢復(fù)、代理隧道、HSTS、Alt-Svc、unix 域套接字、HTTP 壓縮(gzip、brotli 和 zstd)、etags、并行傳輸、DNS-over-HTTPS,等等。
為什么選擇 Curl?因?yàn)樗唵?、無處不在且靈活!
簡單易用:Curl 就像 API 測試的瑞士軍刀。它簡單、直接,不需要編程博士學(xué)位就能使用。只需輸入幾個(gè)命令,按下回車鍵,瞧,你就像專業(yè)人士一樣發(fā)送或測試 API!
隨處可用:無論你是在 Mac、PC 還是 Linux 機(jī)器上,Curl 都能為你服務(wù)。不需要為不同平臺(tái)使用不同的工具,Curl 與每個(gè)人都相處得很好。
讓我們開始發(fā)送 API 請(qǐng)求吧
首先確保你已經(jīng)在電腦上安裝了 Curl。別擔(dān)心,這就像下載一個(gè)應(yīng)用程序或使用包管理器一樣簡單。安裝完成后,你就準(zhǔn)備好了!
你可以從官方網(wǎng)頁下載并安裝 Curl,或者使用像 Homebrew(適用于 macOS 和 Linux)或 Chocolatey(適用于 Windows)這樣的包管理器。
發(fā)送你的第一個(gè)請(qǐng)求
想象一下你想從一個(gè) API 獲取員工列表。使用 Curl 是這樣的:
curl https://dummy.restapiexample.com/api/v1/employees
按下回車鍵,Curl 就會(huì)為你獲取用戶數(shù)據(jù)。就是這么簡單!
輸出
{
"status": "success",
"data": [
{
"id": 1,
"employee_name": "Tiger Nixon",
"employee_salary": 320800,
"employee_age": 61,
"profile_image": ""
},
...
],
"message": "Successfully! All records has been fetched."
}
CURL 選項(xiàng)
在我們開始示例之前,先了解一下 CURL 中一些最有用的選項(xiàng)。這里是一些常用的選項(xiàng):
-H,--header:允許你在請(qǐng)求中包含自定義 HTTP 頭。例如:
curl -H "Content-Type: application/json" https://api.example.com/resource
-d,--data:在請(qǐng)求體中發(fā)送數(shù)據(jù)。適用于 POST 和 PUT 請(qǐng)求。例如:
curl -X POST -d '{"name": "John"}' https://api.example.com/users
-i,--include:在輸出中包含 HTTP 響應(yīng)頭。例如:
curl -i https://api.example.com/resource
-o,--output:將響應(yīng)體寫入文件而不是打印到 stdout。例如:
curl -o response.txt https://api.example.com/resource
-u,--user:提供 HTTP 基本認(rèn)證的憑證(用戶名:密碼)。例如:
curl -u username:password https://api.example.com/resource
-F,--form:以 multipart/form-data 請(qǐng)求發(fā)送數(shù)據(jù)。適用于上傳文件。例如:
curl -F "file=@example.txt" https://api.example.com/upload
-X,--request:指定 HTTP 請(qǐng)求方法(GET、POST、PUT、DELETE 等)。例如:
curl -X POST https://api.example.com/resource
-v,--verbose:顯示關(guān)于請(qǐng)求和響應(yīng)的詳細(xì)信息,包括頭和狀態(tài)碼。例如:
curl -v https://api.example.com/resource
你還可以組合這些選項(xiàng)。你會(huì)在下面看到更多的例子。
CURL CRUD 操作
Curl 支持各種 HTTP 方法,包括 GET、POST、PUT、PATCH 和 DELETE,允許你對(duì) API 資源執(zhí)行 CRUD(創(chuàng)建、讀取、更新、刪除)操作。以下是每個(gè) CRUD 操作的 Curl 命令示例:
POST(創(chuàng)建)
在下面的示例中,“curl -X POST” 表示 HTTP 請(qǐng)求應(yīng)該是 POST 請(qǐng)求。你可以根據(jù)要發(fā)送的請(qǐng)求類型將“POST”替換為其他 HTTP 方法,如 GET、PUT、DELETE 等。
curl -X POST -H "Content-Type: application/json" -d '{"name":"Chamila","salary":"1000","age":"40"}' https://dummy.restapiexample.com/api/v1/create
輸出
{
"status": "success",
"data": {
"id": 1960
},
"message": "Successfully! Record has been added."
}
GET(讀?。?/h2>
GET 是默認(rèn)的 CURL 命令。所以你不需要指定任何選項(xiàng)。
curl https://dummy.restapiexample.com/api/v1/employee/1
輸出
{
"status": "success",
"data": {
"id": 1,
"employee_name": "Tiger Nixon",
"employee_salary": 320800,
"employee_age": 61,
"profile_image": ""
},
"message": "Successfully! Record has been fetched."
}
PUT(更新)
curl -X PUT -H "Content-Type: application/json" -d '{"name":"Chamila A","salary":"2000","age":"40"}' https://dummy.restapiexample.com/public/api/v1/update/2
輸出
{
"status": "success",
"data": [],
"message": "Successfully! Record has been updated."
}
DELETE(刪除)
curl -X DELETE https://dummy.restapiexample.com/api/v1/delete/2
輸出
{
"status": "success",
"data": "2",
"message": "Successfully! Record has been deleted"
}
高級(jí)選項(xiàng)
有時(shí),你需要證明自己的身份或在請(qǐng)求中添加特殊指令。別擔(dān)心,Curl 也能幫你搞定!
添加認(rèn)證:
curl -H "Authorization: Bearer <token>" https://api.example.com/protected/resource
自定義頭:
curl -H "X-Custom-Header: Value" https://api.example.com/users
Curl 就像變色龍——它可以適應(yīng)任何情況!
處理響應(yīng)
發(fā)送請(qǐng)求后,你會(huì)從 API 那里得到響應(yīng)。Curl 可以幫你理解這一切!
檢查響應(yīng)頭:
curl -i https://dummy.restapiexample.com/api/v1/employee/1
輸出
HTTP/1.1 200 OK
Date: Mon, 13 May 2024 21:58:33 GMT
Server: nginx/1.21.6
Content-Type: application/json
Cache-Control: no-cache, private
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 58
Cache-Control: max-age=86400
Expires: Tue, 14 May
2024 21:58:33 GMT
Vary: Accept-Encoding
X-Endurance-Cache-Level: 2
X-nginx-cache: WordPress
X-Server-Cache: true
X-Proxy-Cache: MISS
Transfer-Encoding: chunked
{"status":"success","data":{"id":1,"employee_name":"Tiger Nixon","employee_salary":320800,"employee_age":61,"profile_image":""},"message":"Successfully! Record has been fetched."}
將響應(yīng)數(shù)據(jù)保存到文件:
curl -o response.json https://dummy.restapiexample.com/api/v1/employee/1
格式化 JSON 響應(yīng):
你需要安裝 jq。你可以使用 brew 或 choco 來安裝它。
在 Windows 中
choco install jq
安裝完成后,你可以運(yùn)行
curl https://dummy.restapiexample.com/api/v1/employee/1 | jq
輸出
{
"status": "success",
"data": {
"id": 1,
"employee_name": "Tiger Nixon",
"employee_salary": 320800,
"employee_age": 61,
"profile_image": ""
},
"message": "Successfully! Record has been fetched."
}
沒有 jq 的輸出將會(huì)是這樣的
{
"status": "success",
"data": {
"id": 1,
"employee_name": "Tiger Nixon",
"employee_salary": 320800,
"employee_age": 61,
"profile_image": ""
},
"message": "Successfully! Record has been fetched."
}