什么是YapiUpload

yapiUpload是为IDEA提供的快速编写 yapi 接口文档的工具，在编写好Spring Controller后，通过一系列配置，可以直接生成接口文档到YAPI上。

yapiUpload是开源的
代码仓库在：https://github.com/diwand/YapiIdeaUploadPlugin
文档在：https://github.com/diwand/YapiIdeaUploadPlugin/wiki

如何安装及配置

IDEA安装插件

插件地址：
https://plugins.jetbrains.com/plugin/12276-yapiupload

配置yapiUpload

找到项目文件 .idea/misc.xml，在<project>节点粘贴以下内容。

  <!--yapi配置-->
  <component name="yapi">
    <option name="projectToken">你的token</option>
    <option name="projectId">14</option>
    <option name="yapiUrl">你的yapi地址</option>
    <option name="projectType">api</option>
  </component>

如何使用

编写一个标准的接口

yapiUpload支持很多Javadoc注解，可以在官方文档查看。

上传到文档地址

上传成功

接口列表

登录yapi上查看即可

接口详情

修改时，一般是直接覆盖，高版本yapi的api支持修改。不过好像这个工具还不支持。
接口详情

二次开发

yapiUpload本身是一个IDEA的插件，可以按照IDEA编码进行二次开发。
yapi也提供了二次开发api，可以对该插件做升级。https://hellosean1025.github.io/yapi/openapi.html