推荐一款IDEA插件,堪称后端接口自动生成神器!
Posted Java知音_
tags:
篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了推荐一款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版本后成功)
三、接口编写
接口上的注释自动会生成接口名称和接口的描述信息,实体类里的注释也会自动生成文档里的字段说明
四、生成文档
快捷键:Shift + Alt + E
更多使用教程见官网文档:
https://easyyapi.com/index.html
如果选择yapi,首次需要填写一个yapi服务的地址,如:127.0.0.1:3000
然后需要填写项目的token,这个token是yapi服务器新建项目后生成的token
感谢阅读,希望对你有所帮助 :)
来源:blog.csdn.net/weixin_39190162/article/details/121370036
推荐
PS:因为公众号平台更改了推送规则,如果不想错过内容,记得读完点一下“在看”,加个“星标”,这样每次新文章推送才会第一时间出现在你的订阅列表里。点“在看”支持我们吧!
以上是关于推荐一款IDEA插件,堪称后端接口自动生成神器!的主要内容,如果未能解决你的问题,请参考以下文章