Idea 生成Api插件之 EasyYapi

5,838 阅读2分钟

Idea 生成Api插件之 EasyYapi

网上有很多 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可扩展点很多,其他各种配置,可参考文档自行配置,这里不过多去逐个讲解,有不懂的小伙伴可评论留言。