链接: EasyYapi官方文档.
网上搜到的easyYapi基本上都是千篇一律,比较浅,稍微有点定制的东西都搜不到,帮此把自己的一些心得写出来,后续有新发现也会继续更新
第一步:安装插件
第二步:配置数据
postman的token获取方式:
第三步:导出到yapi
以上就是基本操作了
下面是我一些常用的设置:
我的自定义配置:
# 在输出的url中添加前缀标识
class.prefix.path=/BIform
# 输出参数类中的默认值,也可在文档注释中写明 @default 1111
field.default.value=#default
# tag只以逗号进行分隔
api.tag=#tag
api.tag.delimiter=,
#--------------------
# 添加备注
# export.after=groovy:api.appendDesc("{app.base-path:BIform}对应的地址为: biform")
# 移出 header里面的token
export.after=groovy:api.removeHeader("token")
# 将url里面的特定字符替换
export.after=groovy:api.setPath(api.path().replaceAll("\\{app.base-path:BIform\\}/",""))
# 以下代码是当有特定的接口时,会统一打上备注,只是一个样例 ,希望可以帮助到大家,
# export.after=groovy:```
# def flag = it.hasAnn("com.zeekr.bigdata.cache.annotation.ZeekrCacheable")
# if(flag){
# groovy:api.appendDesc("此接口有缓存,请注意")
# }else{
# groovy:api.appendDesc("此接口没有缓存")
# }
# ```
大家还可以 看下这个链接里面的东西:export.after-配置 (easyyapi.com)