API 版本

了解如何指定在向 REST API 发出请求时要使用的 REST API 版本。

关于 API 版本控制

Apifox REST API 是有版本控制的。API版本的名称基于API版本发布的日期。例如，API版本2024-03-28是在2024年3月28日发布的。

任何具有破坏性的更改都会在新的API版本中发布。破坏性更改是可能会破坏集成的更改。

• 删除整个操作
• 删除或重命名参数
• 删除或重命名响应字段
• 添加新的必需参数
• 将先前可选的参数设置为必需
• 更改参数或响应字段的类型
• 删除枚举值
• 对现有参数添加新的验证规则
• 更改身份验证或授权要求

任何添加性（非破坏性）的更改都将在所有支持的API版本中提供。添加性更改是不应该破坏集成的更改。添加性更改包括：

• 添加操作
• 添加可选参数
• 添加可选请求头
• 添加响应字段
• 添加响应头
• 添加枚举值

当发布新的API版本时，先前的API版本通常会继续支持至少3个月。

指定API版本

您应该使用X-Apifox-Api-Version头来指定API版本。例如：

curl --header "X-Apifox-Api-Version:2024-03-28" https://api.apifox.com/v1/versions

如果请求中没有X-Apifox-Api-Version头，则会收到 422 错误。

:::caution
如果指定的API版本不再支持，继续访问将会收到 422 错误。
:::

支持的API版本

目前支持以下API版本：

2024-03-28