WordPress REST API 初學者指南
你可能也喜歡這些API文章!
鏈接 API 請求（也稱為管道請求或順序 API 調(diào)用）是一種在軟件開發(fā)中管理 API 交互復雜性的技術。當一個任務需要多個 API 調(diào)用才能完成時，這種技術尤為重要。它類似于批量請求處理，但不同之處在于，管道請求通過一個請求觸發(fā)一系列按定義順序執(zhí)行的 API 調(diào)用。序列中的每個 API 請求可以修改請求和響應數(shù)據(jù)，且來自一個 API 請求的響應將作為下一個 API 請求的輸入。當客戶端需要按照特定順序執(zhí)行一系列依賴的 API 請求時，管道請求尤為有用。
在管道的每個步驟中，可以對響應數(shù)據(jù)進行轉(zhuǎn)換或操作，然后再傳遞到下一步。這種方法在需要對數(shù)據(jù)進行規(guī)范化、轉(zhuǎn)換或篩選敏感數(shù)據(jù)時非常有效。它還能幫助減少整體延遲，例如，在等待一個 API 調(diào)用響應時進行另一個 API 調(diào)用，從而縮短完成工作流程所需的總時間。
API 網(wǎng)關是實現(xiàn)該功能的理想位置，因為它能夠攔截所有客戶端請求并將其轉(zhuǎn)發(fā)至目標。本文將使用 Apache APISIX，這是一款流行的開源 API 網(wǎng)關解決方案，內(nèi)置了眾多插件。不過，目前 APISIX 并不官方支持 pipeline-request 插件。為了實現(xiàn)相同功能，我們決定開發(fā)一個新的插件。GitHub 上有一個存儲庫，包含用 Lua 編寫的源代碼以及 pipeline-request 插件的說明。
通過此插件，可以指定按順序調(diào)用的上游 API 列表，以處理單一客戶端請求。每個上游 API 都能修改請求和響應數(shù)據(jù)，來自一個上游 API 的響應將作為輸入傳遞給管道中的下一個上游 API。管道可以在 Route 配置中定義，同時可以設置管道中 API URL 的執(zhí)行順序。
以下是插件的一個使用示例。假設有兩個 API：一個用于發(fā)出 GET 請求以檢索信用卡信息，另一個用于接收 POST 請求正文中的響應數(shù)據(jù)，并在將響應返回給客戶端之前篩選敏感數(shù)據(jù)（如信用卡號和到期日期）。因為信用卡 API 端點返回的信息包含不應對未經(jīng)授權的各方公開的敏感數(shù)據(jù)。下圖展示了數(shù)據(jù)流的整個過程：/credit_cards/filter
當客戶端向 API 網(wǎng)關的信用卡 API 端點發(fā)出請求以檢索信用卡信息時，API 網(wǎng)關會將請求轉(zhuǎn)發(fā)至信用卡后端服務以獲取數(shù)據(jù)。
若請求成功并返回數(shù)據(jù)，數(shù)據(jù)將傳遞到管道中的下一步，即安全服務。
從安全服務收到篩選后的響應后，API 網(wǎng)關將組合響應返回給客戶端。
在本演示中，將使用 GitHub 上的現(xiàn)成演示項目，其中包含本教程所需的所有 curl 命令示例。無需使用 Docker compose.yml 文件進行額外配置，即可運行 APISIX 并啟用自定義插件。
在 fork 或 clone 項目后，從項目根目錄運行，即可輕松安裝 APISIX 和 etcd。請注意，配置文件中指定了一個卷。這將本地目錄 掛載到 Docker 容器中，作為只讀卷，與我們的文件及自定義插件實現(xiàn)一起使用。此設置允許在運行時向 APISIX 添加自定義插件（適用于使用 Docker 運行 APISIX 的情況）。
運行以下命令來啟動 Docker 容器：
docker-compose up在配置文件 docker-compose.yml 中，配置如下：
volumes:
- ./custom-plugins:/opt/apisix/plugins:ro將 ./custom-plugins 目錄掛載到容器中的 /opt/apisix/plugins 目錄。
APISIX 啟動后，可以使用 cURL 命令向 APISIX Admin API 端點發(fā)送 HTTP PUT 請求，以創(chuàng)建第一個監(jiān)聽 URI 路徑的路由 /routes/my-credit-cards。
curl -X PUT 'http://127.0.0.1:9180/apisix/admin/routes/1' \
--header 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' \
--header 'Content-Type: application/json' \
--data-raw '{
"uri":"/my-credit-cards",
"plugins":{
"pipeline-request":{
"nodes":[
{
"url":"https://random-data-api.com/api/v2/credit_cards"
},
{
"url":"http://127.0.0.1:9080/filter"
}
]
}
}
}'配置中最關鍵的部分是 "plugins" 部分，它指定了 "pipeline-request" 插件用于該 API 路由。插件配置包括一個 "nodes" 數(shù)組，定義了管道中 API 請求的執(zhí)行順序。在這里，可以定義一個或多個 API。
在這個示例中，管道包含兩個節(jié)點：
https://random-data-api.com/api/v2/credit_cards API 發(fā)送請求以檢索信用卡數(shù)據(jù)。http://127.0.0.1:9080/filter 發(fā)送請求，以從信用卡信息中篩選出敏感數(shù)據(jù)。第二個 API 是一個使用 serverless-pre-function APISIX 插件的 serverless 函數(shù)，它作為后端服務，修改來自第一個 API 的響應。接下來，配置一個 ID 為 2 的新路由，以處理管道中的請求，并啟用 APISIX 的 serverless-pre-function 插件。我們將在此插件中指定一個 Lua 函數(shù)，該函數(shù)從上一個響應中檢索請求正文，替換 credit_card_number 字段，并保持響應的其他部分不變。最后，函數(shù)將修改后的請求正文設置為當前響應正文，并將 HTTP 200 響應發(fā)送回客戶端。可以根據(jù)需要修改此腳本，例如對解碼后的正文進行進一步處理或驗證。
路由配置示例如下：
curl -X PUT 'http://127.0.0.1:9180/apisix/admin/routes/2' \
--header 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' \
--header 'Content-Type: application/json' \
--data-raw '
{
"uri": "/filter",
"plugins": {
"serverless-pre-function": {
"phase": "access",
"functions": [
"return function(conf, ctx)
local core = require(\"apisix.core\")
local cjson = require(\"cjson.safe\")
-- 獲取請求正文
local body = core.request.get_body()
-- 解碼 JSON 正文
local decoded_body = cjson.decode(body)
-- 隱藏信用卡號
decoded_body.credit_card_number = \"****-****-****-****\"
core.response.exit(200, decoded_body)
end"
]
}
}
}'現(xiàn)在可以測試整體配置。使用以下 cURL 命令向端點發(fā)送 HTTP GET 請求：
curl http://127.0.0.1:9080/my-credit-cards在第二步中配置的路由使用了帶有兩個節(jié)點的插件，該請求將觸發(fā)管道從端點檢索信用卡信息，利用端點過濾掉敏感數(shù)據(jù)，并將修改后的響應返回給客戶端。查看輸出結(jié)果：
{
"uid": "a66239cd-960b-4e14-8d3c-a8940cedd907",
"credit_card_expiry_date": "2025-05-10",
"credit_card_type": "visa",
"credit_card_number": "****-****-****-****",
"id": 2248
}如圖所示，請求正文中的信用卡號（實際上是第一個 API 調(diào)用的響應）已被替換為星號。
到目前為止，我們了解了為 Apache APISIX API 網(wǎng)關定制的流水線請求插件的功能。該插件允許將一系列 API 調(diào)用定義為按特定順序的流水線，并且可以與現(xiàn)有插件結(jié)合使用，為 API 端點啟用身份驗證、安全性以及其他 API Gateway 功能。
原文鏈接：使用 API Gateway 鏈接 API 請求 – API7.ai
