Apifox入门
前言
本篇博客意在简化官方文档,提炼出使用Apifox
必要的一些知识,如果时间充裕,请完整阅读官方文档。
1.简介
国产版的postman
,目前团队人数不设上限,不收费。这也是启用postman
使用apifox
的原因。
2.安装
3.创建团队
我的团队-新建团队。
团队创建完成之后,可以在右侧进行人员的管理和团队项目的管理。
4.项目简介
项目由4部分组成:项目概览、接口、数据模型、快捷请求。
平常主要使用的是接口。
5.接口使用
可以请求接口,同时也是一个完善的接口文档,接口下的用例可以用作示例。你可以给每个接口都定义一个状态和负责人。
配合环境变量可以做到只切换环境就可以请求不同源服务的效果。
6.文档手动美化
在用插件生成文档之后,有些地方不尽如人意,可以手动美化。选择文档-->修改文档。
还可以生成用例,运行-->保存为用例。
返回结果可以提取到响应定义和响应示例。
7.脚本使用
最简单的使用就是获取一些数据并保存在变量中,以登录为例,首先请求验证码接口,获取到验证码,拿到验证码,再请求登录接口,获取token,保存在环境变量中,每个接口都会带上token进行请求。
脚本如下:
// 将接口返回数据,封装成自己需要的结构
var data = {
response: pm.response.json()
}
var uuid = pm.response.json().data.uuid;
// html 模板字符
var template = `<html><img src="data:image/jpg;base64,{{response.data.img}}" /></html>`;
// 设置 visualizer 数据。传模板、解析对象。
pm.visualizer.set(template, data);
pm.globals.set("captcha-key", uuid);
8.IDEA插件生成接口
IDEA
插件市场搜索安装Apifox Uploader
。详细用法见:官方文档。
插件的使用需要获取访问令牌(自己生成)和项目ID,然后在插件中进行配置。
目前插件存在许多的问题,但是可以满足基本的生成文档并调试的需求,基于目前版本,以下是我的配置示例:
# 模块项目ID配置
hil-woss-duty:2135023,值班管理系统
hil-woss-duty-api:2135023,值班管理系统
格式为:模块名:项目ID,文件夹名
目前插件存在问题,无法从@ApiModelProperty
获取字段的中文名,所以需要加注释的方式来实现。
/**
* 所属部门id
*/
@ApiModelProperty(value = "所属部门id")
private String orgId;
文件夹名也是取的controller
的注释,支持多级文件夹,用/
分割。
/**
* 基础管理/值班管理
*/
public class BaseController {}
api取的是@ApiOperation
注释的方法。
插件还支持自定义,详情请见官方文档。