推荐一款IDEA插件，堪称后端接口自动生成神器！

点击上方“Java基基”，选择“设为星标”

做积极的人，而不是积极废人！

每天 14:00 更新文章，每天掉亿点点头发...

源码精品专栏

 

• 原创 | Java 2021 超神之路，很肝~
  

• 中文详细注释的开源项目
  

• RPC 框架 Dubbo 源码解析

• 网络应用框架 Netty 源码解析

• 消息中间件 RocketMQ 源码解析
  

• 数据库中间件 Sharding-JDBC 和 MyCAT 源码解析

• 作业调度中间件 Elastic-Job 源码解析

• 分布式事务中间件 TCC-Transaction 源码解析

• Eureka 和 Hystrix 源码解析

• Java 并发源码

来源：blog.csdn.net/weixin_39190162/

article/details/121370036

• 一、先看效果

• 二、安装

• 三、接口编写

• 四、生成文档

---

一、先看效果

1、生成yapi文档的效果

2、生成postman格式数据并导入接口测试类后的效果（如postman、apifox等工具）

3、生成markdown格式文档的效果

基于 Spring Boot + MyBatis Plus + Vue & Element 实现的后台管理系统 + 用户小程序，支持 RBAC 动态权限、多租户、数据权限、工作流、三方登录、支付、短信、商城等功能

• 项目地址：https://github.com/YunaiV/ruoyi-vue-pro

• 视频教程：https://doc.iocoder.cn/video/

二、安装

1、安装EasyYapi插件

idea的顶部菜单栏选择 文件 -> 设置 -> 插件，然后再marketplace里搜索easyYapi安装即可

安装完成后设置底部回出现EasyApi的栏目，选中进行配置修改（我主要是改了下图红框的位置，不修改使用默认配置也可以，自己可以试试使用json5和不适用json5的区别，我更喜欢看json5格式的文档【也是最近才发现有这个格式的】）

2、安装yapi接口文档管理系统

如果只需要在postman等接口工具中使用，可以跳过此步骤

官方部署文档：

• https://hellosean1025.github.io/yapi/devops/index.html

注意 ：node.js不要安装最高版本（我安装最高版本时安装yapi失败，node.js重新安装12.x版本后成功）

基于 Spring Cloud Alibaba + Gateway + Nacos + RocketMQ + Vue & Element 实现的后台管理系统 + 用户小程序，支持 RBAC 动态权限、多租户、数据权限、工作流、三方登录、支付、短信、商城等功能

• 项目地址：https://github.com/YunaiV/yudao-cloud

• 视频教程：https://doc.iocoder.cn/video/

三、接口编写

接口上的注释自动会生成接口名称和接口的描述信息，实体类里的注释也会自动生成文档里的字段说明

四、生成文档

快捷键：Shift + Alt + E

更多使用教程见官网文档：

• https://easyyapi.com/index.html

如果选择yapi，首次需要填写一个yapi服务的地址，如：127.0.0.1:3000

然后需要填写项目的token，这个token是yapi服务器新建项目后生成的token

---

---

欢迎加入我的知识星球，一起探讨架构，交流源码。加入方式，长按下方二维码噢：

已在知识星球更新源码解析如下：

最近更新《芋道 SpringBoot 2.X 入门》系列，已经 101 余篇，覆盖了 MyBatis、Redis、MongoDB、ES、分库分表、读写分离、SpringMVC、Webflux、权限、WebSocket、Dubbo、RabbitMQ、RocketMQ、Kafka、性能测试等等内容。

提供近 3W 行代码的 SpringBoot 示例，以及超 6W 行代码的电商微服务项目。

获取方式：点“在看”，关注公众号并回复 666 领取，更多内容陆续奉上。

文章有帮助的话，在看，转发吧。
谢谢支持哟 (*^__^*）