APIGit
2023-05-03
Apigit 的環境是一項功能,允許您創建和管理可在您的請求中使用的不同變量集。環境可以被認為是可以在 Apigit 中訪問和修改的鍵值對的集合。
簡而言之,環境是一種存儲變量(例如 URL、訪問令牌和 API 請求中經常使用的其他值)的方法。通過將這些值存儲在一個環境中,您可以輕鬆地在不同的配置之間切換並針對不同的環境運行您的請求,而無需每次都手動更新這些值。
Apigit 中的每個環境都由一組變量組成,包括可由工作區中的所有請求訪問的全局變量,以及僅可用於該環境中的請求的環境特定變量。變量可以手動設置和更新,也可以使用腳本或 Apigit API 動態設置。
您可以在 Apigit 工作區內創建多個環境,並使用環境下拉菜單在它們之間輕鬆切換。這使得針對不同環境(例如開發、暫存和生產)測試您的 API 變得很容易,而無需每次都手動更新您的請求。
在調試 API 時,我們經常需要在本地、開發和生產環境之間來回切換。我們還面臨令牌過期等問題,這可能令人沮喪。一些教程建議使用 Apigit 來簡化流程,但在實踐中,我們仍然可能會遇到一些問題。因此,這篇詳細的博文介紹了使用Apigit的Environments來簡化無縫調試API時在不同環境之間切換的步驟。
使用全局數據環境的步驟:
要編輯您的測試用例文件,請導航至Test Cases
在您的存儲庫中並選擇適當的文件。在默認視圖模式下,單擊側邊欄左下角的 ✏️ 圖標。
要添加或編輯環境集,請單擊Env
按鈕位於頂部欄的中央。從那裡,您可以訪問環境設置並進行任何必要的更改。
您可以選擇在Code
和Form
通過單擊位於頁面右上角的相應按鈕來查看模式。
在Code
模式:
[
{
"type": "code",
"description": "initialization",
"parameters": {
"code": "var baseUrl = env.get(\"baseUrl\");\nvar test = env.get(\"username\");\nif (test == null){\n fail(\"test is null\");\n}\nif (baseUrl == null) {\n state.baseUrl = \"http://petstore.mock.apigit.com\";\n //env.set(\"baseUrl\", \"http://petstore.mock.apigit.com\")\n}\nstate.test = test;\n"
}
},
{
"type": "http",
"description": "get pet inventories by username",
"parameters": {
"method": "get",
"url": "{baseUrl}/store/inventory/{test}",
"query": [],
"auth": {
"type": "{test}"
},
"header": [],
"body": {
"type": "none",
"data": ""
},
"postTest": "if (!res || res.status !== 200) {\n fail(\"get pet inventory failed\")\n}"
}
}
]
在Form
模式:
要使用環境數據,您可以在Code Execution Action
或者Test
部分Http Request Action
.
請注意,使用var
僅限於它自己的部分。如果你定義一個變量,比如test
, 節內Code Execution Action
並希望在HTTP Request Action
節,你必須使用state.test
訪問變量。