idea插件EasyApi导出接口文档到YApi中

文章介绍了如何在IDEA中安装和配置EasyApi插件,以便与YApi配合,自动化生成和导出接口文档。通过设置服务器地址、项目ID和Token,开发者可以从controller直接导出接口文档。此外,还提到了如何添加鉴权逻辑,例如使用Groovy脚本进行登录操作,以确保接口的安全性。

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

        最近公司内部调整接口文档工具,将使用YApi用来定义前后端接口文档的交互沟通工具,公司使用的idea,为了缩短写文档的时间,将使用插件EasyApi来让我们减少些工作量,毕竟有些时候写文档也是个很耗时但又必须要要做的事情,下面我来介绍这些步骤。

1、默认已经打开了idea

2、安装插件并重启idea,这步就不详细介绍了。下图是我本地安装好了的

3.重启后,找到 File-Settings —>other Settings —>EasyApi

server:YAppi的服务地址

tokens:当前要生成的controller文件所在的项目的名称=YAppi上要导入项目的token

项目id获取方式:

项目token获取方式:

4.找到要导出接口文档的controller,右击找到 export,如下图

 出现下图

第一次导出会有弹框弹出让输入项目id和token,按上面获取项目id和项目token方式获取到填入即可。

一般情况下,idea的控制台会输出

 

表示导出成功,到YApi对应的项目文档中就能看到接口说明了,如下图:

 

接口定义的越规范,导出的接口说明就越规范。

在EasyApi下的BuildInConfig中加入鉴权逻辑,使用下面的这种方式进行配置:

 

配置信息:

yapi.export.before=groovy:```
    httpClient.request().url("http://172.31.3.22:30000/api/user/login_by_ldap")
                .method("POST")
                .contentType("application/json")
                .body(["email":"yourname","password":"yourpwd"])
                .call();
```

注意 ```不要丢了

 

image2023-2-23_15-31-13.png

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值