在 Apifox 中,你可以创建和管理多个项目,以便更好地组织和管理接口。创建项目#
团队所有者或团队管理员可通过 “团队项目 -> 新建项目」 -> 新建”,创建新的项目。设置其他团队成员的项目权限#
创建项目时,可通过“其他成员的项目权限”设置当前团队中已有成员在新项目中的项目角色:团队成员:获得所选的项目角色。如果当前团队尚未保存过权限选择,默认选中 只读。
团队所有者和团队管理员:不受此配置影响,自动成为项目 管 理员。
游客:不受此配置影响,对新项目的访问状态默认为 禁止访问。
如需分别设置每位成员的项目角色,可选择 自定义 后逐一配置。
Apifox 会按团队记住你最近一次选择,并在你下次于该团队新建项目时将其作为默认值。选择项目模式#
创建通用类型的 API 项目时,还需要选择接口定义的维护方式。两种模式都支持接口设计、调试、测试和自动化,但采用不同的事实来源和编辑工作流。 | 以可视化界面维护接口 | 以 OpenAPI 文件维护接口(Beta) |
|---|
| 主要维护方式 | 主要通过可视化接口编辑器设计和维护 API。 | 在 Specs 工作区维护 OpenAPI 或 Swagger YAML/JSON 文件;支持的接口内容也可以通过表单视图编辑。 |
| 事实来源 | 保存在 Apifox 项目中的结构化接口数据。 | 保存在项目中或从 Git 仓库同步的接口规范文件。 |
| Git 工作流 | Apifox 自动生成 OpenAPI 规范,可将其备份到 Git 仓库。 | 可连接 Git 仓库进行双向同步,也可以不连接 Git,使用 Apifox 内部存储。 |
| 适用场景 | 偏好可视化操作,希望直接完成接口设计、调试、测试、文档和日常协作的团队。 | 已使用 YAML/JSON 规范文件、通过 Git 评审接口变更,或偏好代码仓库工作流的团队。 |
项目模式需在创建项目时确定,创建后无法修改。两种不同的项目模式无法相互切换。如需改用另一种工作流,请使用所需模式新建项目,再迁移或导入接口定义。
项目概览#
进入到一个已创建项目中,可以在 “接口管理 -> 项目概览” 页中,看到该项目的重要信息和统计信息。接口用例 / 测试场景覆盖#
可以在这个模块内查看当前项目的全部接口,以及接口用例与测试场景的覆盖情况。通过这些统计数字可以直观、量化的了解到当前项目中的接口是否被合理测 试,以及接口质量是否更加可靠。接口用例覆盖率,带有接口用例的接口数/总接口数,主要用来查看单个接口是否有被接口用例覆盖;
平均每个接口带有的用例数,接口用例总数/总接口数, 主要用来查看接口的用例整体完善程度;
不带用例的接口数,主要用来查看未被接口用例覆盖的接口数量;
测试场景覆盖率,被测试场景关联的接口数/总接口数,主要用来查看接口被自动化测试所覆盖的情况;
不被测试场景覆盖的接口数,主要用来查看还没有被自动化测试覆盖的接口数量。
注意:此处数据的计算是异步的,因此会有延迟。如果发现数据有异常可以等待一段时间后再刷新确认。
编辑项目#
团队所有者 / 管理员进入到已创建的项目中,在 “项目设置 -> 基础设置 -> 编辑” 中更换项目的名称或者项目图标。克隆项目#
克隆项目:通过 “项目设置 -> 基础设置 -> 克隆”,可克隆项目到当前团队或其他团队。移动项目#
移动项目:通过 “项目设置 -> 基础设置 -> 移动项目”,将项目移动到其他团队。删除项目#
删除项目:通过 “项目设置 -> 基础设置 -> 删除”,将项目彻底删除。