新建接口
Apifox 为 API 设计者提供了直观的界面来新建接口。下面是一个 “通过 ID 查询宠物信息” 的 API 示例:
新建接口
以下步骤展示了如何创建一个 “通过 ID 查询宠物信息” 的接口:
定义请求路径: 在接口路径栏中输入 /category/{id}
- 名称: 通过 ID 获取类别
- 路径参数:
- 参数名: id
- 类型: integer
- 示例值: 1

设置响应结构:
- 滚动至 返回响应
部分。
- 在 “成功(200)” 响应下,点击 “+” 创建一个名为 “data” 的字段。
引用数据模型:
- 选中 “data” 字段。
- 将类型设置为
Object
,并选择 “引用模型”。- 从列表中选择 “Category” 或相关的数据模型。
<Background>

</Background>
:::tip[使用数据模型]
对于常用的结构化数据,可以将其定义为数据模型,并在请求或响应中进行引用。
:::
</Step>
:::tip[导入现有接口]
你可以导入已有的 OAS 文件 (如 OpenAPI/Swagger 的 .json
或 .yaml
文件) ,而不是从头开始创建 API。详情请见导入数据章节。
:::
最后修改时间: 1 个月前