接口唯一标识

# 接口唯一标识

目前大多数接口是通过 method & path 来区分接口。而有的开发项目(例如一些电商 API 文档),接口请求的 URL 是不变的,通过 Query / Header 中的参数来区分接口。

在 2.2.9 版本之后,我们新增 接口唯一标识 功能,新增支持 operationIdQuery 参数Body 参数Header 参数 作为区分接口的唯一标识的参数。

# 1. 设置接口唯一标识

接口唯一标识 定义为 目录 层级的设置。当你需要设置某个接口为唯一标识的时候,需要再其接口的 父级目录 中设置。根据你的需要,选择你需要的唯一标识参数,点击保存后对该目录下的所有接口生效。

举例:某一个电商 API 接口,以 Query 参数 的参数 action ,作为 接口唯一标识 的参数。在下图选择为 Query 参数 后,在其右侧的输入框中输入对应的参数名。

# 2. 填写对应的唯一标识的参数值

设置目录的 接口唯一标识 后,点击该目录下的某个接口,点击 修改文档 tab,在接口的基础信息中,和下方的请求参数中,均有一个 K 的 icon,均代表该 接口唯一标识 的参数。

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

# 3. 文档页显示唯一标识

接口-修改文档 页填写了 接口唯一标识 的值后,在 接口-文档 页以及在 在线文档 显示如下。

# 4. 导入

当你的项目中已经是通过 Query / Header 中的参数来区分接口,通过 OpenAPI 格式 的文件导入 Apifox 时,如下页面。

导入时匹配接口的规则,根据导入的目标 目录 的设置为准。当导入的目标 目录 的设置 接口唯一标识 不符合需要时,可以在导入设置中修改;修改后,会直接对目标 目录 生效。

举例:某一个电商 API 接口,以 Query 参数 的参数 action ,作为 接口唯一标识 的参数。如下页面,导入 Apifox 时,点击编辑 修改 接口唯一标识

注意

  1. 已经使用 Query 参数 固定值 的功能的用户,不用担心,功能依然会保留。但 固定值 在导入时是根据 URL 进行覆盖判断的,建议已经使用 固定值 功能的用户使用 接口唯一标识 功能。
  2. 接口唯一标识 功能支持设置多个参数。