APIFox
核心功能
ApiFox追求的是Api设计,APi调试.前端开发,APi自动测试
基本流程
先进入首页<个人空间>,里面可以创建一个项目,默认会有一个叫<个人项目>的项目
点击进入<项目>就可以进入核心功能区
可以看到核心功能就是左边的侧边栏
- 接口管理
- 分享文档
- 请求历史
- 项目设计
接口测试
点击紫色的+号按钮,或者标题栏的+号 可以<新建>一些功能
快捷请求
最常用的就是快捷请求,用于测试api
可以看到主要内容就是
- 选择GET请求还是其他请求方式
- 输入url
- 编辑请求具体的内容
- 特别内容是<前置操作>,<后置操作>,<设置>这三个功能
点击发送可以看到结果
点击保存 保存为接口
这个功能是用于编写api文档的
通过编辑接口的名称,保存接口的路径,最后将接口文档保存在相应的目录结构中
我们就可以通过目录结构清晰的观察到整个系统的api结构
接口管理
当我们保存为接口之后,点击进入
可以看到多了一栏,,分别是
- 接口中的请求规范
- 接口的响应规范
- 接口说明
- ….
响应定义
这个功能是很重要的,对于前端开发
可使用Mork,,也就是自动生成对应格式的随机数据,这样前端可以在后端没有的情况下测试效果
最关键的是根节点哪里的数据格式规范
如果选择的是json返回类型,那么就可以定义JSON的数据格式,设置这个格式可以为后面提功 mork功能做基础
简单的非Map类型,可以直接通过选择字段类型来设置JSON结构
对于复杂的Map类型(也就是key和value都是随机的),需要先选择为Object,点击旁边的高级配置
选择允许额外字段(也就是随机生成字段)
然后我们就可以使用mork了
数据模型
之前的基本流程中没有说完整关于响应数据的定义一个Mork功能,这部分专门介绍
我们在定义好的一个响应数据模型,,可能不仅仅使用在一个接口中,或许许多接口或者请求数据都会是相同的的模型
所以我们可以保存起来,,让接口引用这些模型
在<接口管理>的侧边栏中,有一个数据模型的下拉菜单,在里面可以创建目录用于存放模型(一般按照项目名创建目录)
点击新建数据模型
关键是这里<通过JSON等生成>
以及<根节点>那个结构
通过JSON等生成
第一个通过JSON生成,,实际上优势仅仅是快,缺点是不能解析Map数据类型
JSON Schema是一种描述json格式的json对象语法
我们也可以通过连接数据,从数据库中导入一个表的所有字段
通过自定义设置模型
可以通过可视化点击这个东西来配置数据的模型
配置Map类型
Map类型的问题就是字段不确定,也就是key有哪些是不确定的,key的值和数量都是随机的
我们选择一个字段为object类型(map在JSON中也是通过object保存的)
点击旁边的高级设置
点击<额外字段>设置为允许,,这样就会随机生成 字段属性
这个字段的值类型可以选择,, 点击配置可以继续配置这个值类型中的详细类型
预览
点击<预览>
可以看到生成的对应模型的数据,,可以点击<动态生成>,,立即生成另一些数据展示
生成代码
实际上含义是<得到能生成这种数据的代码>
例如选择java语言
在后端开发的时候就可以直接复制