api generator插件使用

前言

公司里推广使用yapi是好几个月之前的事情了，今天发现了一个好用的插件

可以通过控制层接口直接生成yapi文档，免去了手写yapi接口的烦恼

开始

这里直接贴图介绍最快速的配置过程

后续我会贴上git地址，里面对于配置的介绍更详细

• step1：打开idea插件库搜索Api Generator，并下载

• step2：完成后点击settings左下角的Other Settings，按步骤点击
  

• step3: 进入到这个页面

第一栏YApi server url，输入yapi地址或者yapi部署的地址，图示我输入了

https://yapi.linshang.com/

其他参数看下面的步骤

• step4: 打开你的yapi，当前正在编写的项目，比如我现在在写邻商装修，就打开邻商装修项目

• step5：进入当前项目后，点击上方的设置，从弹出的选项卡中选择token设置，并复制token值

• step 6:将token复制到插件中，并设置你将要新增的接口的文件夹名

  这里我使用默认的文件夹名api_generator 并应用

  下方还有一个单选框，勾选该选项后，生成文档时插件将从controller类注释里抽取模块名，并在yapi上自动创建对应分类保存接口

• step 7: 在控制层接口的方法签名中右键，并点击generate api选项

​ 如果创建成功，右下角会提示Upload Api Success

• step8：进入到yapi查看效果吧

​ 接口参数，返回值，什么的，都有哦

使用体验

优点

• 基于javadoc，没有代码入侵

• 自动生成文档，契合我们yapi的使用，提升生产力

  其余优点可以查看git https://github.com/Forgus/api-generator

缺点

• 第一次使用就发现，如果我们的返回值是用ResultData封装过的，返回参数就没啥意义了

• git中介绍的配置，比如Classify API automatically选项，可以获取控制层注释，自动创建分类的功能，我打勾了，但是会生成接口失败

• 同事使用的graphQL项目无法使用该插件

结语

又是提升生产力的一个好东西

参考文献

插件开源地址：https://github.com/Forgus/api-generator