编写IntelliJ IDEA插件
参考文章:https://www.cnblogs.com/mushan/p/12275581.html
https://github.com/diwand/YapiIdeaUploadPlugin
源代码:https://github.com/diwand/YapiIdeaUploadPlugin.git
YAPI上传插件,利用YAPI提供的save接口,上传接口信息。
通过idea插件上传YAPI接口文档步骤
仅支持IDEA 2021.3以上的版本
使用过程分如下三步:
一,安装idea插件
二,配置idea
三,选择接口名,或者接口方法名,右键选择UploadToYapi,即可上传。
一,安装idea插件,插件附件如下:
yapi插件:通过idea插件上传YAPI接口文档-Java文档类资源-CSDN下载
1,进入idea settings安装如上附件yapi_idea_upload_plugin插件:
安装完成,重启idea,可以看见如下插件TPBankYapiUpload,即安装成功。
二,配置idea。
在.idea目录下的misc.xml文件中,加入配置如下:
<component name="yapi">
<option name="projectToken">d1d92db3ca4e570f8e1505bc86e7013fedd9a4d5c0ae91cefa0f87714438bc8d</option>
<option name="projectId">254</option>
<option name="yapiUrl">http://loan-yapi.101bank.sh</option>
<option name="projectType">api或dubbo</option>
<option name="attachUploadUrl">http://localhost/fileupload</option>
<option name="returnClass">CrlZdCommonResponse</option>
</component>
备注:
projectType如果是controller提供的http接口则写api,其他写dubbo;
projectToken:对应yapi登录用户的token
projectId:对应yapi的项目ID
yapiUrl:http://loan-yapi.101bank.sh
projectToken从yapi中获取,如下:
项目ID如下:
具体配置如下:
接口的备注中,需要写上传的YAPI目录,接口描述:
/**
* @param request 助贷-还款申请请求
* @description 还款申请接口
* @return 助贷-还款申请响应
* @menu 诺诺接口
* @tag develop-slow-d1
* @status done
*/
三,选择接口名,或者接口方法名,右键选择UploadToYapi,即可上传。