设计 API
可以把响应组件作为默认响应吗?
不可以。
响应组件主要用于通用的错误响应,比如 400、404 这类状态码。如果你需要使用固定的默认响应,请直接用默认响应模板。
怎么查看是谁修改了接口?
点击接口右上角的历史记录,就能看到所有以前的修改记录,可以还原到某个版本。
如何在 Apifox 中批量删除目录?
目前,Apifox 还没有批量删除目录的功能,你只能一个一个地删除每个目录。
如果需要批量接口,可以在项目的 “根目录” 中筛选接口来删除。
如何在 Apifox 中批量删除接口?
如果需要批量接口,可以在项目的 “根目录” 中筛选接口来删除。
如何批量删除目录?
目前,Apifox 还没有批量删除目录的功能,你只能一个一个地删除每个目录。
怎么给接口批量添加或删除 URL 前缀?
Apifox 目前不支持通过批量操作来修改接口 URL。不过你可以这样做:
先从 “项目设置 -> 导出数据” 里把文件导出成 Apifox 格式。
然后用文本编辑器 *(比如 VSCode)* 批量查找并进行替换。
最后再...
如果一个字符串属性有多个枚举值,而且在不同地方都用到了,怎么才能保证这个枚举在整个文档里都保持一致?
你可以把这个属性定义成一个单独的数据模型,里面就一个属性。这样你就能在 API 文档的不同地方统一引用它了。例如:
如何获取 Apifox 的资源目录 ID?
点击目录,打开目录设置页面,即可找到目录 ID

如何在 URL 路径中使用变量?
在 Apifox 中,路径中的变量部分我们通常会定义为一个路径参数。例如输入{petId},可以在下方看到 Path 参数。此时可以定义参数值为引用全局变量/环境变量值,例如 {{id}}。设置后当你发送请求时,实际请求中路径会被替换成变量 id 的实际值。
。操作完成后,右键导出 HAR 文件,然后一键导入 Apifox 中。创建一个测试场景并将所有请求导入即可随时回放。导入 Har 文件的方式可以参考 导...
在定义接口响应时,是否允许接口没有任何响应内容?
麻烦升级到最新版,接口定义中支持将响应的内容格式设置为 No-Content,表示没有响应体。

接口/文档/测试场景不小心删除了怎么办?
Apifox 支持回收站功能,您可以轻松恢复误删的接口、目录、数据模型、测试场景等资源。
点击 Apifox 页面右下角的回收站图标。
选中需要恢复的资源(支持多选)
点击“恢复”按钮即可。
此外,如果误改了接口、文档、数据模型,您还可以通过历史记录恢复到之前的版本:
打开需要恢复的接口。
点...
Apifox 是否支持自定义接口的请求代码?
Apifox 支持在接口中自定义示例代码。您可以按照以下步骤操作:
进入项目设置 -> 功能设置 -> 接口功能设置,将接口字段中的示例代码开关打开
![image.png](https://api.apifox.com/api/v1/projects/5097254/resour...
如何在 Apifox 接口列表中设置显示 接口名称 或 接口 URL?
为什么接口定义的字段在文档中看不到?
Apifox 文档中请求/响应参数的可见性受高级设置中的行为属性控制。请检查对应字段的高级设置行为是否设置了Read Only 或 Write Only
Read Only:用作请求参数时,该字段将被隐藏
Write Only:用作返回结构时,该字段将被隐藏
![image.png](ht...
如何获取项目ID?
Apifox 中查看项目 ID 的方法:
打开项目。
点击左侧导航栏的“项目设置”。
在“通用设置”中选择“基本设置”。
在“基本信息”中找到“项目ID”,点击即可复制。
<img src="https://api.apifox.com/api/v1/projects...
如何快速编辑 JSON 数据结构中的必填字段?
Apifox 提供了便捷的方式来快速调整 JSON 数据结构中的必填字段。您可以通过修改 JSON Schema 中的 required 属性值来实现。
例如,如果您的数据结构中只有 id 字段为必填字段,而需要将其他字段设置为非必填,可以按照以下步骤操作:
打开 JSON Schema 编辑器。...