配置
代码规范
下载YapiUpload插件
idea推送到YAPI
idea代码中添加注释
类注释demo
/**
* @Description:
* @author: niwenhua
* @Date: $Date$ $time$
* @menu 数据集
*/
符合工程的配置
projectId:打开yapi点击项目,查看url中project后面的数字为项目id
yapiUrl:部署的yapi的服务地址http://ip:端口projectType:根据你要上传的接口类型决定,如果为dubbo接口就填dubbo,如果是api接口就填api,我们填api
配置
status用于YAPI中对应接口完成状态,分为3种,已发布(don,设计中(desig,开发中(undon,已提测(testin,已过时(deprecate,暂停开发(stopin,新增接口默认开发中。
测试接口
打开spring项目中的Controller文件右键文件内容选择Generate或者用'Alt+Insert/Ctrl+Enter/ALT+SHIFT+S(快捷键可能不一样)'然后选择'ExportYapi(bet'
方法注释样本
/**
* @Description: $description$
* @Author: 作者姓名
* @UpdateUser: 更新人姓名
* @Param: $param$
* @Return: $return$
* @CreateDate: $date$ $time$
* @UpdateDate: $date$ $time$
* @version: 1.0
* @status: done
*/
menu对应YAPI中的分类名称,如下
良好的代码书写和注释习惯类、方法、类的属性上需要添加注释
控制台信息
在类上添加@menu表示属于YAPI中哪个分类
插件文档
总结
在方法上添加@menu表示类中的该方法属于YAPI哪个分类,如果在方法上添加了@menu,在YAPI中该方法会单独变成一个分类。
找到idea项目所在盘符打开.idea文件打开misxml
idea推送到YAPI
使用EasyYApi插件
控制台显示上传成功
前提
打开spring项目中的Controller文件或者在IDEA的左边项目文件区域选择文件或者文件夹使用快捷键'快捷键ALT+SHIFT+E(windows)/ctrlE(ma'然后选择要导出的API,选择导出渠道为yapi点击[✔]按钮或者按回车键完成导出
两个插件结合IDEA都能实现将接口推送到YAPI平台,YapiUpload在注解上相对简单些,可统一使用YapiUpload
projectToken:打开yapi->具体项目->设置->token配置
参数解释
在misxml中添加以下内容
类属性注释样本
/**
* 名称
*/
private string name;
使用YapiUpload插件
EasyYapi文档
方法二
在打开的类名上右键,选择”UploadToYapi”
方法三
在IDEA的左边项目文件区域选择文件或者文件夹鼠标点击最上方code>ExportYapi(bet
方法一
注释模板需统一
下载EasyYApi插件
控制台提示导出成功信息
方法四
如果用的是Eclipse,快捷方式Shift+Alt+S,选择Call。如果用的idea,快捷方式ALT+INSERT,选择Call
文章为作者独立观点,不代表股票交易接口观点