前言
不知道小伙伴,有没有编写接口文档的痛苦,虽然现在市面上有很多关于管理接口的方法,如swagger,postman,apifox 等,但是仍然有很多缺陷和不足的地方,那有没有不用粘贴复制就能写出一个整齐简洁的接口文档呢?我的回答是有。
实现方式
IDEA插件Apifox Helper + Apifox
参考文档
具体实现
1.下载IDEA插件
在IDEA设置中,插件管理中下载插件Apifox helper
2.Apifox生成API访问令牌
- 打开Apifox软件
- 点击账号头像
- 选择账号设置
- 选择API访问令牌
- 生成对应的API访问令牌,记住这个令牌要保存好
3.IDEA插件设置
- 点击IDEA设置,选择ApifoxHelper
- 填入对应的API访问令牌(上一步中生成的),模块id在具体项目的项目设置中
最终效果
1.接口导入
- 选择接口类,右键选择upload to Apifox 即可
3.对象类导入
如果设计到接口返回的类没有在接口中说明,则需要使用对象类导入的方法。具体过程如下:
- 找到接口返回的对象类
- 右键选择To Json5
- 将生成的JSON导入到ApiFox的
- 将需要关联的接口关联到对应的数据模型
- 如果生成的Json格式数据存在中文乱码,则把Apifox Helper中项目格式设置为跟随系统即可