一、阐述：

本文主要讲述如何利用Java doc生成Yapi接口文档

二、现象：

常见接口文档的形式一般分为以下几种：

（1）手写word接口文档。效率最为低下

（2）利用swagger生成接口文档。效率较高，但需要写很多不必要注解，代码不简洁

（3）利用swagger+yapi生成接口文档。实质还是swagger

（4）利用Java doc生成接口文档。效率最高，代码最简洁

三、步骤：

1、工具：

简述：在相关类、接口、属性上标好对应的注释，再通过以下IDEA插件一键上传接口信息到YAPI平台即可。其中RedsoftYapiUpload插件作为YapiIdeaUploadPlugin插件的修改版，使用起来更加方便

Yapi：https://github.com/YMFE/yapi

YapiIdeaUploadPlugin插件：https://github.com/diwand/YapiIdeaUploadPlugin

RedsoftYapiUpload插件：https://github.com/jinfeijie/yapi

2、安装

（1）安装Yapi：

         安装Yapi之前还需安装node、mongodb

         <1>安装node

         <2>安装mongodb

         <3>安装yapi

         <4>Yapi安装成功之后会出现以下界面

         <5>在平台手动建立相关项目

（2）安装RedsoftYapiUpload插件

         直接在插件市场搜索下载即可

3、配置

简述：配置RedsoftYapiUpload所需的Yapi地址、项目ID、项目token

（1）Yapi地址

（2）项目ID

（3）项目token

4、应用

简述：在类、接口、实体上标好注释，然后可以选中类或者接口进行上传。

（1）类、接口注释

（2）实体注释

（3）上传

（4）效果