EasyYapi:后端接口自动生成IDEA插件
一、先看效果
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版本后成功)
三、接口编写
接口上的注释自动会生成接口名称和接口的描述信息,实体类里的注释也会自动生成文档里的字段说明。另外,推荐公众 号Java精选,回复java面试,获取面试资料,支持在线刷题。
四、生成文档
快捷键:Shift + Alt + E
更多使用教程见官网文档:https://easyyapi.com/index.html
如果选择yapi,首次需要填写一个yapi服务的地址,如:127.0.0.1:3000
然后需要填写项目的token,这个token是yapi服务器新建项目后生成的token
作者:随时看 https://blog.csdn.net/weixin_39190162/article/details/121370036
公众号“Java精选”所发表内容注明来源的,版权归原出处所有(无法查证版权的或者未注明出处的均来自网络,系转载,转载的目的在于传递更多信息,版权属于原作者。如有侵权,请联系,笔者会第一时间删除处理!
最近有很多人问,有没有读者交流群!加入方式很简单,公众号Java精选,回复“加群”,即可入群!
(微信小程序):3000+道面试题,包含Java基础、并发、JVM、线程、MQ系列、Redis、Spring系列、Elasticsearch、Docker、K8s、Flink、Spark、架构设计等,在线随时刷题!
特别推荐:专注分享最前沿的技术与资讯,为弯道超车做好准备及各种开源项目与高效率软件的公众号,「大咖笔记」,专注挖掘好东西,非常值得大家关注。点击下方公众号卡片关注。
文章有帮助的话,点在看,转发吧!