导入 OpenAPI (Swagger) 数据 手动导入 手动导入-文件导入 手动导入-URL 导入 导入-高级设置 自动导入 导入 OpenAPI (Swagger) 数据 支持导入 OpenAPI 3 、Swagger 1、2、3 数据格式的 json 或 yaml 文件。 手动导入 打开 项目设置 面板，点击 手动导入 ，...

接口设计 (接口文档) 快速上手 接口路径 基础信息 请求参数 Params 参数 Body 参数 Body 参数类型 参数中使用环境变量（或全局变量/临时变量） 返回响应 公共响应 响应示例 其他 OperationID 接口设计 (接口文档) 接口设计即定义接口文档规范（如接口路径、参数、返回值、数据结构等）。 新人注意...

数据结构 / 数据模型 数据结构 JSON 智能识别/快捷导入 编辑数据结构 数据模型 管理数据模型 数据模型的引用 预览 生成代码 编辑源码 数据结构 / 数据模型 数据结构 数据结构 和编程语言里的数据结构类似，主要使用在 接口设计 的返回响应 和 json / xml 类型的Body 参数 。 JSON 智能识...

在线分享 分享在线文档 查看在线文档 在线接口文档支持运行调试 在线文档支持修改环境变量 在线文档支持显示示例代码 Run in Apifox 链接 URL 规范 1. 链接地址 2. 传递环境变量 3. 传递请求参数 1. 简单模式 2. 高级模式 在线分享 在 API 开发、沟通、协作中，逻辑上是以 API 文档为标准的，但实...

配置文件 示例代码 接口文档 SwaggerUI 返回中间件 配置文件 这里使用YAML 配置文件：config.yaml server : address : ":8199" openapiPath : "/api.json" swaggerPath : "/swagger" 示例代码 ...

Mock 语法 基本写法 Mock 语法 基础类型 正则表达式 日期/时间 图片 颜色 中文文本 中文姓名 Web 相关 地址相关 其他 英文文本 英文姓名 Mock 语法 Apifox Mock 语法完全兼容 Mock.js （数据占位符方式），并扩展了一些 Mock.js 没有的语法（如国内手机号 @phone）。 注...

配置文件 示例代码 接口文档 SwaggerUI 返回中间件 配置文件 这里使用YAML 配置文件：config.yaml server : address : ":8199" openapiPath : "/api.json" swaggerPath : "/swagger" 示例代码 ...

接口调试 / 接口用例 快速上手 保存为用例 接口参数 前置操作/后置操作 断言 提取变量 校验响应 控制台 接口调试 / 接口用例 设计好接口文档后，就可以直接 运行 接口来调试了。 新人注意 和 Postman 不一样，Apifox 是区分接口设计 和接口运行 两个概念的。 接口设计 ：即 新建接口 界面或接口详情里的...

断言 (测试请求结果) 使用示例 断言请求返回的结果是否正确 将请求返回的结果数据写入环境变量 检查 response body 是否包含某个字符串 检查 response body 是否包含等于字符串 检查 json 值 检查 header 是否有设置 Content-Type 检查请求响应耗时是否低于 200 毫秒 检查 HTTP 状态码是...

一、基本介绍 二、简单示例 1、配置文件 2、示例代码 3、接口文档 4、SwaggerUI 5、返回中间件 三、如何使用 1、路由方法定义 2、请求/返回结构体 3、数据校验 4、数据返回 5、路由注册 四、OpenAPIv3 协议 五、Ctx 中的Request 对象 六、常见问题 1、在规范路由下，同一接口如何支持多种...