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

一、先看效果

1、生成yapi文档的效果

e12dabaa7c3e5559bddeb8610e080d7f.png

图片

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

9abcc7df3a8e7dd8f351acf8641b2efe.png

图片

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

7e81c0ecfb14c6ba4b565b199c4046a7.png

图片

二、安装

1、安装EasyYapi插件

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

24c0b1c9f92223961b5de30bff423d1c.png

图片

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

00fdcdc138377e4cd21cbd33eaae0de8.png

图片

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

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

官方部署文档:

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

注意 :node.js不要安装最高版本(我安装最高版本时安装yapi失败,node.js重新安装12.x版本后成功)

三、接口编写

7dd12ad264a806d8b53380a5dd277ed6.png

图片

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

四、生成文档

快捷键:Shift + Alt + E

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

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

88755fa04144ccdaa1b5e4f0da24ac76.png

图片

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

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

4c80af7871af163b70aa134ce8d6382e.png

图片

感谢阅读,希望对你有所帮助 :)

来源:blog.csdn.net/weixin_39190162/article/details/121370036

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

加小编微信,回复 40 白嫖40套 java/spring/kafka/redis/netty 教程/代码/视频 等

 
 
 
 
扫二维码,加我微信,回复:40
 注意,不要乱回复 
没错,不是机器人记得一定要等待,等待才有好东西
  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值