青年IT男

个人从事金融行业,就职过易极付、思建科技等重庆一流技术团队,目前就职于某网约车平台负责整个支付系统建设。自身对金融行业有强烈的爱好。同时也实践大数据、数据存储、自动化集成和部署、分布式微服务、人工智能等领域。

yapi idea 上传插件,快速生成文档

yapi idea 上传插件,快速生成文档

YapiIdeaUploadPlugin

目的

减少yapi 录入时间,通过工具反向规范代码注释,和代码整洁

支持语言

java

单个&批量

单个上传选中方法
批量上传选中类名

支持接口

目前 dubbo 接口/api

支持yapi 的版本

1.5.0+

使用方式

  • 下载yapiupload jar 包 (或者在idea 插件库搜索)
  • 打开idea,preferneces->plugins-> install plugin from disk(或者搜索 yapiupload),导入jar 包后(install),重启
  • 配置信息:在项目目录下,.idea 文件夹下,找到misc.xml (如果找不到.idea 请查看是否被折叠或被隐藏) 如果是 .ipr 模式创建的 就找到 项目名.ipr

token 获取方式: 打开yapi ->具体项目->设置->token 配置
项目id 获取方式:点击项目,查看url 中project 后面的数字为项目id http://127.0.0.1:3000/project/72/interface/api
yapiUrl 固定
projectType 根据你要上传的接口类型决定,如果为dubbo 接口就填dubbo ,如果是api 接口就填api

<component name="yapi">
  <option name="projectToken">yapi 中项目token</option>
  <option name="projectId">yapi 中项目id</option>
  <option name="yapiUrl">http://127.0.0.1:3000</option>
  <option name="projectType">api</option>
</component>
  • 如果是dubbo 项目,选中dubbo interface 文件中的一个方法(要选中方法名称),右击YapiUpload(alt+u 快捷键)
  • 如果是api 项目,选中controller 类中的方法名称或类名(要选中方法名称,或类名,选中类名为当前类所有接口都上传),右击YapiUpload(alt+u快捷键)

注意:接口会上传到一个临时文件目录下 tool-temp,根据需要移动

使用规则

  • 良好的java doc 注释能生成更好的文档,如下:生成的文档中属性就可以带上注释
/** 
* 年龄
*/
private Integer age;

生成的文档接口名称就可以使用:添加或更新课程数据,没有注释默认使用接口路径做为名称

    /**
     * 添加或更新课程数据
     *
     * @param courseOpt
     * @return {@link CommonRes}
     */
    @RequestMapping(value = "/test", method = RequestMethod.POST)
    public Course addOrUpdateCourse(@RequestBody CourseParam courseParam){

    }


    /**
     * @description: 添加或更新课程数据
     * @param: [sources, count]
     * @return: java.util.List<com.btime.recommend.dto.babyRearing.BaseBabyRearingDO>
     * @date: 2018/3/15
     */
     @RequestMapping(value = "/test", method = RequestMethod.POST)
     public Course addOrUpdateCourse(@RequestBody CourseParam courseParam){

    }
  • 支持@link 参量定义展示在字段备注中
第一种@link 方式

/** 
* 状态 {@link com.xxx.constant.StatusConstant}
*/
private Integer status;


第二种@link 方式

import com.xxx.constant.StatusConstant;

/** 
* 状态 {@link StatusConstant}
*/
private Integer status;


不支持方式
import com.xxx.constant.*;

/** 
* 状态 {@link StatusConstant}
*/
private Integer status;
0
1028826685@qq.com

评论已关闭。