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

点击关注公众号,实用技术文章及时了解97c8d3064a81b3d1b9664ed9918f6431.png

一、先看效果

1、生成yapi文档的效果

87d7fa70b44fb5e1ef146ab02027d17e.png

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

50d67b5464e882754c1efeb47a400dd2.png

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

bd76ffa302ddc3616619ebe44bbfd9a9.png

二、安装

1、安装EasyYapi插件

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

8038180f8f78c56d4704509f72611d91.png

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

e15443d62bd193e303bde88218d88fd1.png

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

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

官方部署文档:

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

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

三、接口编写

d3d6aadf0f85ad04136c4dc0a1d57451.png

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

四、生成文档

快捷键:Shift + Alt + E

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

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

9483126cf6853671b4e16fccebcba693.png

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

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

4c018f782ce3d0fd99202d690919129a.png

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

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

推荐

Java面试题宝典

技术内卷群,一起来学习!!

f4a73df9fa1c799f702eca99a594da28.jpeg

PS:因为公众号平台更改了推送规则,如果不想错过内容,记得读完点一下“在看”,加个“星标”,这样每次新文章推送才会第一时间出现在你的订阅列表里。点“在看”支持我们吧!

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值