阅读全文

⭐⭐⭐ Spring Boot 项目实战	⭐⭐⭐ Spring Cloud 项目实战
《Dubbo 实现原理与源码解析 —— 精品合集》	《Netty 实现原理与源码解析 —— 精品合集》
《Spring 实现原理与源码解析 —— 精品合集》	《MyBatis 实现原理与源码解析 —— 精品合集》
《Spring MVC 实现原理与源码解析 —— 精品合集》	《数据库实体设计合集》
《Spring Boot 实现原理与源码解析 —— 精品合集》	《Java 面试题 + Java 学习指南》

摘要: 原创出处 blog.csdn.net/weixin_39190162/article/details/121370036 「随时看」欢迎转载，保留摘要，谢谢！

• 一、先看效果
• 二、安装
• 三、接口编写
• 四、生成文档

---

🙂🙂🙂关注**微信公众号：【芋道源码】**有福利：

1. RocketMQ / MyCAT / Sharding-JDBC 所有源码分析文章列表
2. RocketMQ / MyCAT / Sharding-JDBC 中文注释源码 GitHub 地址
3. 您对于源码的疑问每条留言都将得到认真回复。甚至不知道如何读源码也可以请教噢。
4. 新的源码解析文章实时收到通知。每周更新一篇左右。
5. 认真的源码交流微信群。

---

一、先看效果

1、生成yapi文档的效果

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

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

二、安装

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版本后成功）

三、接口编写

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

四、生成文档

快捷键：Shift + Alt + E

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

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

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

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