评论

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

1、 牛逼的监控系统,不接受反驳!!

2、 分布式锁用 Redis 还是 Zookeeper?哪家强?

3、 从3s到25ms!看看人家的接口优化技巧,确实很优雅!!

4、 看了我的 mybatis-plus 用法,全公司同事开始悄悄模仿了。。

5、 支付宝:多线程事务怎么回滚?说用 @Transactional 可以回去等通知了!

文章来 源: http://t.csdn.cn/peyZQ

目录

  • 一、先看效果

  • 二、安装

  • 三、接口编写

  • 四、生成文档

一、先看效果

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

1、 京东一面:MySQL 中的 distinct 和 group by 哪个效率更高?太刁钻了吧!

2、 使用 try-catch 捕获异常真的会影响性能?

3、你的 IDE 太重了,试试 Emacs吧!

4、还在手写CRUD代码?试试这款代码生成工具吧,彻底解放双手!

5、JetBrains 如何看待自己的软件在中国被频繁破解?

6、无话可说,北邮211本科不符合华为OD要求,清华硕士符合!

7、RESTful真垃圾?试试 GraphQL?

8、这 7 个GitHub仓库,够学一辈子!

9、低欲望的后厂村:“遍地”985、211,高收入低消费,偏爱996

10、Javalin:一个超轻量级Web Framework! 返回搜狐,查看更多

责任编辑:

平台声明:该文观点仅代表作者本人,搜狐号系信息发布平台,搜狐仅提供信息存储空间服务。
阅读 ()