基本概念
本节介绍了 Apifox 中的一些核心概念,这些概念与其它类似产品 (如 Postman) 可能有所不同,理解这些定义和区别,有助于更好地掌握 Apifox 的工作流程,帮助你快速上手。文档模式/调试模式#
Apifox 的 API 调试有两种模式,可以在界面左下角切换,分别是:文档模式
和 调试模式
。这两种模式提供了类似的功能,但界面不同,以适应不同团队的工作流程。文档模式是 Apifox 推荐的模式,适合采用 API 设计优先的团队。在这个模式中,团队首先定义 API,随后根据 API 文档进行开发和测试。调试模式则特别适合那些没有事先定义 API 文档的团队。这样的团队通常集中在后端开发,先完成代码,然后再生成 API 文档进行测试工作。如果需要调用其他人开发的 API 而没有文档,建议也使用调试模式。Apifox 是一个以 API (接口) 为核心的产品,这意味着所有操作都从定义 API 开始。在 Apifox 的主界面中,接口是基本元素,它们以目录的形式进行分组。对于每个接口,你可以进行修改、预览、发送请求,或者将请求保存为接口用例。这种结构与 Postman 大不相同,Apifox 更像是一种基于 OAS (即 OpenAPI Specification,一种用于描述和定义 RESTful API 的标准化格式)的扩展——你可以直接调试和保存请求。在 Postman 中,基本元素是 “请求”,而这些请求与 API 定义 (即 API specification,是定义和描述 API 行为的关键文档或标准) 本身是分离的。这意味着当 API 定义发生变化时,所有的请求和脚本都需要重新编写。在 Apifox 中,所有的接口用例 (对应 Postman 的请求) 都是基于 API 定义 (API specification) 的。当 API 定义发生变化时,接口用例会同步变化,所有基于此的测试场景和 CI/CD 也可以自动或手动更新,非常适合开发团队在维护和更新 API 时使用。快捷请求#
测试场景#
当你需要批量发送请求时 (类似运行 Postman Collection),你可以使用自动化测试来编排测试场景。Apifox 中的环境与 Postman 中的环境类似,包含许多变量。切换环境时,可以使用相同环境变量的不同值。然而,Apifox 的环境还包括另一个重要概念:服务。每个服务对应一个前置 URL。由于 OpenAPI/Swagger 中定义的接口都以 /
开头,它们可以被发送到不同的服务。在 Apifox 中,你无需在请求开头写 {{Base_url}}
来设置服务为变量。只需切换到对应的环境,所有请求都会自动发送到该环境中的相应服务。接口、快捷请求、数据模型、环境、测试场景等的集合构成了一个项目。在 Apifox 中,项目是协作的基本单位。与 Postman 相比,Apifox 项目大致相当于 Postman 的 Collection,而 Apifox 团队则类似于 Postman 的 Workspace。 修改于 2025-03-21 06:24:10