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
访问变量。