使用请求代理调试
在 Apifox 内进行接口请求、调试时,可以使用代理的方式对接口实际发起请求,从而避免网络环境原因无法从本地请求到接口等情况。有以下两种方式能够影响在接口调试时,是否使用请求代理。
个人请求代理设置
进入一个项目后,在 Apifox 右下角,可以看到请求代理设置。你可以使用以下几种方式来代理你在 Apifox 上发起的接口请求。
当你使用 Apifox 客户端时:
使用软件代理:从 Apifox 发起的接口请求,使用软件设置中的请求代理设置进行代理。注意是在 “接口请求代理配置” 中设置的代理,才会在接口请求时生效。如果软件设置中的 “接口请求代理配置” 选择不使用代理,则接口请求会直接从客户端发送到接口。
使用自托管请求代理 Agent:从 Apifox 发起的接口请求,使用当前指定的自托管请求代理 Agent 进行代理。
当你使用 Apifox 网页端时:
- 自动选择代理:Apifox 会根据当前使用的浏览器情况,来自动选择使用浏览器插件 Agent 还是云端 Agent 来代理接口请求。优先会使用浏览器插件 Agent 来代理请求。
- 浏览器插件 Agent:使用浏览器插件 Agent 来代理接口请求。需要安装浏览器插件后才可用。
- 云端 Agent:使用 Apifox 提供的云端请求代理 Agent 来代理接口请求。需要注意这个 Agent 无法访问内网接口。
- 使用自托管请求代理 Agent:从 Apifox 发起的接口请求,使用当前指定的自托管请求代理 Agent 进行代理。
此个人请求代理设置是会保存在云端的,每个项目都会保存针对当前项目的设置,以便下次再调试项目中接口时能够快速使用正确的请求代理设置。
不同环境服务下的请求代理设置
进入一个项目后,在项目的环境管理功能中,可以针对不同的环境和服务(前置 URL),设置使用不同的自托管请求代理 Agent。服务被指定了请求代理 Agent 后,在 Apifox 中所有向此服务发起的接口请求都会被此 Agent 代理。适合不同服务的接口有不同的网络环境的场景,可以统一配置请求代理,来减少每个成员都需要设置正确代理的工作。
提示
- 如果在服务中已指定了请求代理 Agent,则此处的设置优先于个人请求代理设置。例如服务中设置了使用请求代理 A,但是某个成员右下角的请求代理设置为不使用请求代理,则该成员向此服务中的接口发起请求时,仍然会通过 A 代理请求。
- 服务中的请求代理 Agent 设置,仅针对端内发起的接口请求生效。从分享文档、公开文档站中发起的接口调试仍然会使用该分享中设置的跨域代理来实际代理请求。
也可以直接在右下角的请求代理设置中,查看/设置当前项目所有环境服务指定的请求代理 Agent。
环境服务中指定的请求代理 Agent,是保存在云端并且全项目成员共享的设置。