新建接口
接口管理 模块中创建新接口，点击 新建接口 按钮。1.
2.
3.
4.
5.
文档模式（以设计为主）和 调试模式（以代码为主）。可以在界面左下角切换模式。本文基于 文档模式 。了解更多关于文档/调试模式的信息。接口路径
/起始，使接口更规范，并且使用 Apifox 过程中能获得更好更完整的功能体验。推荐路径以
/ 开头的原因/ 开头路径有助于在 OpenAPI 生态中的兼容性。如果路径没有以 / 开头，在使用工具时可能会遇到兼容性问题。/ 开头的路径支持 URL 模式 Mock 功能，这对 Apifox 的测试和验证功能非常重要。请求方法
1.
2.
3.
4.
5.
6.
7.
8.
9.
接口描 述信息
接口的描述性名称，用于概述接口的功能。
该接口文档的可见性，方便灵活控制项目资源的访问权限。
默认为 “开发中”，可在接口状态下更改，标识不同阶段如 “测试中” 或 “已发布”。
指定负责该接口的成员，可以从项目成员中选择用户分配此角色。
关键词或短语，用于对接口进行分类或描述。可以键入新标签或从已有标签中选择。
接口路径的基础 URL，默认为“继承自父级”，也可以通过界面右上角的环境设置手动指定。
在 API 中帮助区分该操作的唯一标识符 （OAS 中的 operationId）。
详细说明接口的目的及用途，支持 Markdown 格式。
请求参数
Query 参数
? 开始，以 & 分隔，例如：?id=2&status=available。通常用于筛选、排序或修改 API 的输出。Path 参数
正确示例
/pet/{petId}错误示例
/pet/:petId{参数名}，Apifox 就会自动识别，并在下方自动显示对应的参数输入框。{} 占位符格式，变量只写在 Path 参数的 “参数值” 中。推荐的写法：在 Path 参数的参数值里引用变量
在 URL 栏保留占位符格式，例如
/pet/{petId}在 Path 参数列表中找到
petId，在 “参数值” 里使用双大括号 {{}} 填入变量名，例如 {{petId}}。这样就相当于在 URL 路径里使用变量了。不推荐的写法：把变量直接写在 URL 栏里
{{}}会影响 Apifox 的 Mock API 功能的使用。另外，这种写法不符合 OAS 规范，无法在 OpenAPI 生态的工具中正常集成。因此，不推荐在 URL 上直接写变量，例如 /pet/{{petId}}区分
{parameter} 和 {{variable}}{parameter}：单大括号表示 Path 参数，是 URL 路径中的占位符，当访问接口时会替换为具体的值。{{variable}}：双大括号用于在请求中引用变量，请求发送时可替换为实际值，实现动态和自定义输入。请求头参数
请求体参数
参数描述
1.
2.
3.
4.
true 或 false）。5.
数据结构
JSON 或 XML 时，需要设置数据结构。数据结构可引用 数据模型。返回响应和示例
1.
2.
JSON、XML、HTML、Raw、Binary 或其他适合的格式。3.
JSON 和 XML 格式可以配置数据结构。4.
添加返回响应
返回响应 模块右上角的 + 添加 按钮，即可添加返回响应。200 OK 响应因各个接口的输出需求不同而有所差异，但错误响应如 400 Bad Request 和 404 Not Found 往往在不同接口间一致。Apifox 针对此类需求提供了响应组件功能，可以复用预定义的错误响应，从而提高文档编写效率并保持 API 的一致性。添加空白响应 来定义各接口独特的返回结果。添加 响应示例
自动生成示例
自动生成，Apifox 会根据 “返回响应的数据结构” 定义自动生成合理的响应数据。