IDEA插件YapiUpload配置YApi

前后端分离开发项目，后端提供接口文档，这次使用的是YApi，不想一个个接口添加，所以用插件批量导入。

YApi 是高效、易用、功能强大的 api 管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API，YApi 还为用户提供了优秀的交互体验，开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。

官网传送门：

官网：YApi Pro-高效、易用、功能强大的可视化接口管理平台

GitHub：GitHub - YMFE/yapi: YApi 是一个可本地部署的、打通前后端及QA的、可视化的接口管理平台

YApi支持多种方式的导入，通过注释模板来生产接口文档，功能非常强大。

这里只是介绍IDEA中YapiUpload插件的配置。

首先是下载，看图吧，这个不是重点：老生常谈，要注意插件版本和IDEA版本的对应。

 这就安装好了，提示重启IDEA就重启一下好了。

接下来是配置，最简单的配置方式：修改配置文件，添加YApi项目ID和Token

 

 添加内容：token、项目ID、YApi服务器地址

<component name="yapi">
    <option name="projectToken">xxxxx</option>
    <option name="projectId">210</option>
    <option name="yapiUrl">http://xx.xx.xx.xx:3000/</option>
    <option name="projectType">api</option>
  </component>

内容来源：你的YApi服务器里面对应的项目信息，添加到插件的配置文件中。YApi这里请参考官网说明。

 配置好之后使用方式：在需要生成接口的类代码窗口右键，一般是Controller中

右下角有导入成功的提示：

在YApi服务器你的项目中就可以看到生成的接口信息了。 

这里只是介绍入门使用，具体的用法请参阅官网。

补充下用法：

1、在类注释中使用@menu 注解，声明接口的分类。

2、方法注释上，方法描述就是生成接口名称。

如:

@menu 系统管理-用户管理

/**
     * 分页查询
     *
     * @param
     * @return
     */