idea集成easyYapi方法

本文介绍了如何在Idea中安装和配置EasyYapi插件,以便于接口的生成和管理。步骤包括:通过插件市场安装,设置Yapi管理平台的服务器地址和项目token,以及如何将接口推送到Yapi。注意,Controller文件需包含注释,方法需添加@RequestMapping等注解,并且方法注释用于生成接口名称,@NotNull注解用于标记必填参数。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

Yapi是一个接口管理平台,而easyYapi是方便接口生成和管理的一个idea插件。

1  打开插件安装页面 idea>file>setting>plugins  搜索easyYapi 安装后重启

插件中心下载失败的话,可以通过压缩包的形式导入:

2 配置server和token

server 就是yapi管理平台服务器地址 

token 是识别项目的唯一信息  图中就是项目token,不同的项目token 不一样

idea中配置server和token 

idea>file>setting>EasyYapi 如下图

将server和token 填写完成 点击ok 

3 将接口推送至yapi管理平台

 方式一 选中controller文件可以选多个(鼠标在文件目录上) ,或者选择整个文件夹 alt+shift+e 就可以了

 方式二 选中单个controller文件 (鼠标在文件内部) 右键generate ->export yapi 

注意:controller.java文件必须要有文件注释,文件中的方法需要添加注解@RequestMapping/@PostMapping等任意一个 不添加无法识别方法为接口方法 。就算父类方法添加了注解@RequestMapping/@PostMapping也无法识别, 方法必须添加方法注释(接口名称就是根据方法注释生成)

入参对象属性加上注解@NotNull 就变成必输了。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值