轻松与他人协同使用数据库连接配置

原有的数据库操作

Apifox 作为一款接口文档+调试+mock+测试的协同工具，其中有一个备受好评的功能就是在发送/接收请求时，支持数据库操作。这个功能极大的方便了大家在请求接口时需要制作请求数据，或在接收到接口响应时需要插入数据到数据库中的操作，从而深得用户喜爱。

但是在大量用户每天大量实际使用这个功能的过程中，也发现了一些可优化点。其中最容易被 cue 到的一条是：

数据库连接的配置能不能团队管理员配置好了之后，其他人可以协同使用啊？每个人都要重新写一遍连接信息真的挺麻烦的。

其实在这个功能设计之初，我们便考虑到了是否允许数据库配置能够协同使用的问题。但是基于当时的实际情况，Apifox 是一个名气不大的 SaaS 工具产品，允许用户将数据库的账号、密码等敏感信息保存在其云服务器上，用户敢上传吗？即使用户敢，我们也不敢保存这么敏感的信息。所以，数据安全是当时没有做协同使用数据库连接配置功能的核心原因。

云端储存数据库连接配置

到了如今，Apifox 已经是上百万开发者的主要 API 协同管理工具了，同时 Apifox 本身自己的基础能力也迭代的更加强大。因此，我们重新考虑了协同使用数据库连接配置这个优化需求，尽量做到数据安全与高效使用的平衡，期望让用户们能够满意。

当你的 Apifox 版本更新至2.6.50及以上，进入项目设置 -> 数据库连接，点击新建数据库连接时，即可发现所有连接字段会引导你使用变量形式来填入字段的值。

在环境管理中，于环境变量内设置好不同环境下需要使用的数据库连接的变量，这样即可将这些变量应用在数据库连接配置中。

回到数据库连接配置页，你可以使用变量格式手动填入变量，也可以通过动态值功能直接引用这个变量。我们推荐使用环境变量填入此处，这样可以随着不同环境的上下文，自动切换不同环境对应的配置。除端口号外，其他字段都最好使用变量形式。

将使用变量的数据库连接配置进行保存，就可以在接口管理、自动化测试等地方的数据库操作中进行使用了。

保存在本地的配置（使用了明文）	保存在云端的配置（使用了变量）
1. 某个接口请求时，执行到了数据库操作，读取其中指定的数据库配置； 2. 读取数据库配置详情，在本地文件中找到实际值； 3. 使用本地找到的实际值（host, username, password 等）拼接成完整的数据库连接配置，发起连接； 4. 连接成功，执行数据库操作中写的 SQL 以及保存至变量等操作。	1. 某个接口请求时，执行到了数据库操作，读取其中指定的数据库配置； 2. 读取数据库配置详情，在云端读取到使用了变量，根据变量名与变量优先级查找实际值； 3. 进行变量替换，拼接成完整的数据库连接配置，发起连接； 4. 连接成功，执行数据库操作中写的 SQL 以及保存至变量等操作。

其他项目成员需要使用这个数据库连接配置的话，现在只用去环境管理中，找到对应的变量并填入本地值即可，不用像以前需要去项目管理中进行配置。

以上，是使用云端数据库连接的具体操作步骤。当然 Apifox 仍然支持使用明文填入数据库连接配置中并保存在本地，用以兼容以前的数据，以及仍然期望使用本地数据的需求。不过会有强提醒告知用户可以转换成使用变量来保存至云端，提升使用体验。

使用云端数据库连接的注意事项

数据库连接配置中，使用了变量，实际保存在云端的内容为变量名，执行数据库连接时，会根据变量使用规则来拼成完整的连接配置，发起连接。

端口号因为没有数据安全问题，所以填入内容一定会保存至云端，你可直接填写明文。

如果您使用了变量本地值或Vault 变量，连接配置的明文不会保存在 Apifox 云服务器中，不会有数据安全风险，✅ 推荐使用。

如果您使用了变量远程值，则连接配置的明文会保存在 Apifox 云服务器中。虽然团队中每个人都不需要在本地值内再填写一遍，协同效率有提升，但可能存在数据安全风险，❌ 不建议这样使用。

除端口号外，❌ 不建议在一个数据库连接配置中明文与变量混用，因为这样跟完全使用明文保存在本地没有任何区别。

使用 Vault 变量来保存数据库连接配置

数据库连接配置，推荐使用 Vault 变量写入配置中，这样可兼得保存在云端的协同高效率，与数据安全的最佳效果。

Apifox 商业旗舰版可使用 Vault Secrets（密钥库）功能

设置 Vault 变量，将数据库连接的明文存入 Vault 变量中。不同环境的数据库连接配置，要在你的提供商中创建不同的 Vault Key。具体方法参考 Vault Secrets（密钥库）。

在不同环境中，都创建相同名称的环境变量，例如：dbHost。然后在远程值中设置引用该环境对应的 Vault 变量，并保持本地值跟随远程值。

这样做的目的是：

使用环境变量包一层 Vault 变量，让后续设置数据库连接配置时只需要选择环境变量即可，实际使用数据库连接配置时，会跟着环境上下文自动选择此环境的连接配置；

保存在远程值中，为了让项目成员无需再手动设置一次，提升协同使用效率。

在数据库连接中，填入在环境管理中设置好的数据库连接变量。可以使用“动态值”功能快速引用变量。

点击测试连接，会提示选择需要测试的环境，注意测试连接的环境里一定要配置好对应的变量实际值。点击确认发现连接成功。如果有问题可根据具体报错信息进行处理。

在某个接口请求的前/后置操作中，添加一个数据库操作，并选中上述已保存在云端的数据库连接配置，发起请求。例如，我需要从数据库表中找到宠物名为“Nancy”的宠物的 id，然后请求接口查询详情。

发现 Apifox 成功执行了数据库操作，在数据库中取出了数据并根据我的要求将 petID 的值保存至 petId 变量中，然后请求出去了。

如果你已按照上述步骤配置好了数据库连接配置，其他项目成员即可直接在接口请求的数据库操作内指定使用此配置，来对数据库进行操作，无需再自己配置。

以上，即是使用 Vault 变量来保存数据库连接配置，并且实际应用的实践。其中关键要点：

把每个环境的数据库连接配置，除端口之外，都设置一个 Vault 变量。例如测试、正式环境分别有 Vault 变量：testDBHost、prodDBHost；

使用环境变量，在每个环境中都添加同名变量，并在这些环境变量的远程值中引用对应环境的 Vault 变量值。例如按照下表方式配置好测试、正式环境两个环境下的变量与具体变量远程值（本地值保持跟随远程值即可）：

	环境变量名	变量远程值	说明
测试环境	dbHost	{{vault:testDbHost}}	引用测试环境数据库地址的 Vault 变量
	dbUsername	{{vault:testDbUsername}}	引用测试环境数据库用户名的 Vault 变量
	dbPwd	{{vault:testDbPwd}}	引用测试环境数据库密码的 Vault 变量
	dbTable	store	没有数据安全问题，所以直接使用明文。当然也可选择引用 Vault 变量
正式环境	dbHost	{{vault:prodDbHost}}	引用正式环境数据库地址的 Vault 变量
	dbUsername	{{vault:prodDbUsername}}	引用正式环境数据库用户名的 Vault 变量
	dbPwd	{{vault:prodDbPwd}}	引用正式环境数据库密码的 Vault 变量
	dbTable	store	没有数据安全问题，所以直接使用明文。当然也可选择引用 Vault 变量

延伸阅读

《通过 CLI 运行包含云端数据库连接配置的测试场景》

《通过 Runner 运行包含云端数据库连接配置的测试场景》

轻松与他人协同使用数据库连接配置

原有的数据库操作#

云端储存数据库连接配置#

使用 Vault 变量来保存数据库连接配置#

延伸阅读#

原有的数据库操作

云端储存数据库连接配置

使用 Vault 变量来保存数据库连接配置

延伸阅读