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

一、先看效果

1、生成yapi文档的效果

43d96cf13a4bfaea8b487217f9657c8b.png

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

eefd5484f68ef9d5360b2c40efa9a159.png

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

2463e7207565d000b382a983353214df.png

二、安装

1、安装EasyYapi插件

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

1c6000bb5906de6154e821c2fc457023.png

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

33d67aff9e9f5dbe5d5120295458ea73.png

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

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

官方部署文档:https://hellosean1025.github.io/yapi/devops/index.html

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

三、接口编写

ce87922f2befb6afb8814553f2433df1.png

接口上的注释自动会生成接口名称和接口的描述信息,实体类里的注释也会自动生成文档里的字段说明。另外,推荐公众 号Java精选,回复java面试,获取面试资料,支持在线刷题。

四、生成文档

快捷键:Shift + Alt + E

更多使用教程见官网文档:https://easyyapi.com/index.html

e76306bed200fc22ca566c22be9dee7b.png

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

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

14131fa549569b1babab594d69cbedbb.png

作者:随时看

https://blog.csdn.net/weixin_39190162/article/details/121370036

 
 
 
 
公众号“Java精选”所发表内容注明来源的,版权归原出处所有(无法查证版权的或者未注明出处的均来自网络,系转载,转载的目的在于传递更多信息,版权属于原作者。如有侵权,请联系,笔者会第一时间删除处理!
最近有很多人问,有没有读者交流群!加入方式很简单,公众号Java精选,回复“加群”,即可入群!

Java精选面试题(微信小程序):3000+道面试题,包含Java基础、并发、JVM、线程、MQ系列、Redis、Spring系列、Elasticsearch、Docker、K8s、Flink、Spark、架构设计等,在线随时刷题!
------ 特别推荐 ------
特别推荐:专注分享最前沿的技术与资讯,为弯道超车做好准备及各种开源项目与高效率软件的公众号,「大咖笔记」,专注挖掘好东西,非常值得大家关注。点击下方公众号卡片关注。

点击“阅读原文”,了解更多精彩内容!文章有帮助的话,点在看,转发吧!
  • 0
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值