Java后端接口自动生成神器 -- EasyYapi插件(Yapi接口管理工具在IDEA里的插件)

Java后端接口自动生成神器 – EasyYapi插件(Yapi接口管理工具在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
在这里插入图片描述

  • 6
    点赞
  • 33
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
问题:idea接口生成插件是什么?如何使用? 回答:idea接口生成插件是一种用于在IDEA开发环境中生成接口文档的插件。其中,Yapi是一种常用的接口管理平台,可以与该插件配合使用。首先,需要在IDEA中安装该插件,可以通过快捷键Shift + Alt + E来使用插件。\[2\]接下来,需要填写Yapi服务的地址,如127.0.0.1:3000,并填写项目的token,该token是在Yapi服务器新建项目后生成的。\[2\]如果需要进行额外配置,可以参考官方文档中的说明进行设置。\[3\]通过使用该插件,可以方便地生成接口文档并与Yapi进行集成。 #### 引用[.reference_title] - *1* *2* [Java后端接口自动生成神器 -- EasyYapi插件(Yapi接口管理工具IDEA插件)](https://blog.csdn.net/weixin_39190162/article/details/121370036)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v91^control,239^v3^insert_chatgpt"}} ] [.reference_item] - *3* [Idea 生成Api插件EasyYapi](https://blog.csdn.net/weixin_40863968/article/details/122432678)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v91^control,239^v3^insert_chatgpt"}} ] [.reference_item] [ .reference_list ]

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值