导读
通过 YApi的 开放 API , 首先我们会产生一个想法, 开发一个 IDEA 的插件, 产生这个想法以后,就去先去插件市场里搜寻, 果然已经有很多大佬先一步开发好了. 这里先一步帮大家也筛选了一下, 选择了对代码 0 入侵的 EasyYapi
一、EasyYapi概述
1.1 EasyYapi是什么?
官网地址:https://easyyapi.com/
官网的介绍:For yapi Not only for yapi。
EasyYapi是一款Idea插件,帮你导出API到YApi、postman、markdown。
1.2 EasyYapi特色
1.3 EasyYapi优势
(1)基于javadoc&KDoc&ScalaDoc解析API文档
(2)你可以在保持代码零侵入的情况下得到相当完整的api文档, 但是特殊的需求还是需要部分特殊的注释/注解配合
(3)与之相对的是, 你可以灵活的运用配置规则来适应你的项目特性以减少代码侵入.
特殊声明: 由于scala插件中提供的openapi变化过于频繁, 不再作为默认支持选项. 需要在scala项目中使用的开发者可自行从easy-yapi/releases获得支持scala的插件包
二、EasyYapi安装
2.1 EasyYapi支持的IDE
l IntelliJIDEA 173+(2017.3+)
l IntelliJ IDEA Community Edition173+(2017.3+)
2.2从IDEA仓库中安装
· Preferences(Settings) > Plugins > Browse repositories... > find"EasyYapi" > Install Plugin
2.3装手动下载安装
下载插件 Jetbrains orGithub -> Preferences(Settings) > Plugins > Install plugin fromdisk... 重启 IDE.
Jetbrains的 easyyapi的地址:
https://plugins.jetbrains.com/plugin/12458-easyyapi
Github的easyyapi地址:
https://github.com/tangcent/easy-yapi/releases
2.4安装成功验证
点击idea的导航的code可以看到:
2.5使用
支持以下使用方法:
(1)打开项目中的包含api/rpc的文件或者在IDEA的左边项目文件区域选择文件或者文件夹, 使用快捷键alt shift E(windows)/ctrl E(mac), 然后选择要导出的API,选择导出渠道Yapi/Markdown/Postman, 点击[✔]按钮或者按回车键完成导出
(2)打开项目中的包含api/rpc的文件或者在IDEA的左边项目文件区域选择文件或者文件夹, 鼠标右键点击文件内容或文件夹, 选择ExportYapi/ExportPostman/ExportMarkdown导出该文件或文件夹中所有的api
(3)在IDEA的左边项目文件区域选择文件或者文件夹, 鼠标点击最上方Code > ExportYapi/ExportPostman/ExportMarkdown
(4)鼠标点击最上方Code > YapiDashBoard, 然后就可以用鼠标将左边的API拖动到右边yapi目录中,完成API导出到Yapi
(5)鼠标点击最上方Code > ApiDashBoard, 然后就可以用鼠标将左边的API拖动到右边postman目录中,完成API导出到Postman
(6)打开项目中的包含api的文件, 右键文件内容选择Call,就可以发起对当前文件中的API的请求
三、EasyYapi使用实战
。。。。。。。。。。。。。。。。。
版权原因,完整文章,请参考如下:SpringBoot使用EasyYapi对代码0侵入实现API接口一键发布到YApi - 第422篇