接口唯一标识

接口唯一标识功能要求 Apifox 版本 ≥ 2.2.9。

目前大多数接口通过请求方式和接口路径进行区分。而部分开发项目，例如电商 API 文档，接口请求的 URL 是不变的，需通过 Query / Header 中的参数来区分接口。

而“接口唯一标识”使得 operationId、Query 参数、Body 参数、Header 参数能够作为区分接口的唯一标识的参数。

1. 设置接口唯一标识

“接口唯一标识”是归属于目录层级的设置。当你需要设置某个接口为唯一标识时，需要在接口的“父级目录”中进行设置。选择需要的唯一标识参数，点击保存后对即对该目录下的所有接口生效。

举例：现在存在一个电商 API 接口，它以 Query 参数 作为参数 action ，这可以作为“接口唯一标识”的参数。

在下图选择“Query 参数”后，在右侧的输入框中输入对应的参数名。

2. 填写标识的参数值

在“接口唯一标识”中点击该目录下的某个接口。点击“修改文档”选项后，你可以看到接口的基础信息和下方的请求参数中，均带有一个 K 的 icon，表示这是该 接口唯一标识 的参数。

你可以在对应参数下填入对应的值并以此作为接口唯一标识的值。

3. 查看显示唯一标识

设置“接口唯一标识”后，接口页将出现以下显示：

4. 导入外部接口

导入时匹配接口的规则，根据导入的目标“目录”设置为准。若导入目标的目录设置中的“接口唯一标识”不符合需要，可以在导入设置中修改；修改后将直接对目标的“目录”生效。

举例：某一个电商 API 接口，以 Query 参数 的参数 action 作为 “接口唯一标识”的参数。如下图所示，在导入 Apifox 时点击“编辑”按钮并修改“接口唯一标识”。

注意

1. 将 Query 参数作为“固定值”功能依然会保留。但“固定值”在导入时依然是根据 URL 进行覆盖判断，建议将“固定值”改用“接口唯一标识”功能。
2. “接口唯一标识”支持设置多个参数。
3. 如果你的目录中只有某个子目录特殊设置为“接口唯一标识”，导入 Swagger 并更新全部目录时，请避免将全部项目导入到根目录进行更新。推荐将已设置“接口唯一标识”的接口单独导入到该特殊子目录中。

5. Mock 数据

若接口设置了 接口唯一标识 为 Body 参数、Header 参数，在使用 Mock 服务时需要发送“路径 + 唯一标识的参数与参数值”才能获得对应的 Mock 数据。

注意

已设置“接口唯一标识”的项目，接口填写需要保持规范，避免出现相同 URL 的接口但没有设置“接口唯一标识”的情况，造成无法正确的获得 Mock 数据。