Idea 生成Api插件之 EasyYapi

本文介绍Idea EasyYapi插件的安装、配置及使用方法,并重点分享如何通过额外配置实现API指定返回值等功能,适合希望提高API文档生成效率的开发者。

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

网上有很多 idea EasyYapi 插件的博客,但是没有介绍额外配置的,最近我们使用到了额外配置,我参考了官方文档 ,然后记录下,考虑到已经有很多博客了,这里没有对太细的注释中的一些变量做讲解,官方文档上都有EasyYapi,这里主要介绍额外配置使用方式,前序是安装和使用过程。

1、安装插件

在这里插入图片描述

2、配置使用Yapi插件

位置:Preferences(Settings) > Other Settings > EasyApi
支持Yapi、postman、swagger
在这里插入图片描述

Yapi 配置

在上方图片中 Yapi > server 位置配置Yapi对应地址后

Yapi 使用

右键Controller类 > Generate > Export Yapi
此时提示需要输入token,token获取位置:yapi对应的项目 > 设置 > token设置
在这里插入图片描述

Postman 配置

在上方图片中 Postman > token 位置配置Postman中项目对应的token
Postman token获取Postman Integrations Dashboard

Postman 使用

右键Controller类 > Generate > Export Postman
在这里插入图片描述

3、其他额外配置

Easy Yapi提供了额外使用的配置文件(以 设置api指定返回值为例)

  1. 在项目根路径下添加 .yapi.config 文件,其格式为properties格式,官方支持的 文件名及格式如下 文档地址:EasyYapi
    在这里插入图片描述
  2. 加载外部的配置文件
    可以是内外网可访问文件 或 本地文件
    在这里插入图片描述文件内容如下(两种模式二选其一,推荐使用 link 模式,与Java注释一致,可链接)
# 支持设置返回类型 package 模式(不建议)
method.return=#real_return
# 支持设置返回类型 link 模式(建议)
method.return[#real_return]=groovy:helper.resolveLink(it.doc("real_return"))

官方文档位置:method_return
新增配置的使用方式
在这里插入图片描述

总结

EasyYapi可扩展点很多,其他各种配置,可参考文档自行配置,这里不过多去逐个讲解,有不懂的小伙伴可评论留言。

评论 3
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值