Apifox IDEA 插件
  1. 配置
Apifox IDEA 插件
  • 快速上手
    • 介绍
    • 安装
    • 实战使用
    • 获取访问令牌
    • 获取项目 ID
    • 导出API
    • 常见问题 FAQ
  • 配置
    • 如何使用配置?
    • 使用项目内配置文件
    • 其他
    • 配置文档
  • 进阶使用
    • 注释规范说明
    • 框架支持
    • 支持的回调--暂不用
  1. 配置

使用项目内配置文件

使用项目内配置文件#

【推荐】尽量在项目根目录下创建配置文件来管理配置即可.
【可选】在模块根目录下创建配置文件 .apifox-uploader
【可选】在模块 resources 下创建 application.{yml|yaml|properties}

配置文件的类型#

文件类型
.apifox-uploader.configproperties
.apifox-uploader.yml 或 .apifox-uploader.yamlyml

properties 类型配置(推荐)#

格式说明#

一般的配置是:key=value
简单的多行配置,以\结尾:
key=value\
    aaaa\
    bbb
key2=value2
复杂的多行配置,以```结尾开启多行配置,以单独一行```表示结束:
key=groovy:```
if(condition){
    //some script
}
```
带filter的配置:
key[filter]=value
注意key[filter]=value有可能解析错误,可以尝试切换成
key=groovy:if(filter)value
以下三条配置等价:
#单行配置
http.call.before=groovy:logger.info("call:"+request.url())
#以\接新行
http.call.before=groovy:\
logger.info("call:"+request.url())
#以```包裹多行
http.call.before=groovy:```
logger.info("call:"+request.url())
```

加载额外配置 properties.additional#

在配置文件中可以使用properties.additional来加载额外的配置文件:
properties.additional=$additional_properties_file_path$
常用于需要存放用户相关的配置

yml/yaml 类型配置#

使用snakeyaml解析
参考: baike | wiki

多层级配置示例#

假设配置后的目录结构如下:
project-root
├── java(module1)
│   ├── common.iml
│   ├── pom.xml
│   ├── src
│   │   ├── main
│   │   │   ├── java
│   │   │   │   └── com
│   │   │   │       └── **
│   │   │   │           └── **
│   │   │   │               └── **
│   │   │   │                   └── **.java
│   │   │   └── resources
│   │   └── test
│   │       └── java
│   └────.apifox-uploader.config①
├── kotlin(module2)
│   ├── kotlin-demo.iml
│   ├── pom.xml
│   ├── src
│   │   ├── main
│   │   │   ├── kotlin
│   │   │   │   └── com
│   │   │   │       └── **
│   │   │   │           └── **
│   │   │   │               └── **
│   │   │   │                   └── **
│   │   │   │                       └── **.kt
│   │   │   └── resources
│   │   │       ├── application.yaml②
│   │   │       ├── static
│   │   │       └── templates
│   │   └── test
│   │       └── kotlin
│   └────.apifox-uploader.yml③
├── springboot-demo(module3)
│   ├── pom.xml
│   ├── springboot-demo.iml
│   └── src
│       ├── main
│       │   ├── java
│       │   │   └── com
│       │   │       └── **
│       │   │           └── **
│       │   │               └── **
│       │   │                   └── **
│       │   │                       └── **
│       │   │                           └── **.java
│       │   └── resources
│       │       ├── application.properties④
│       │       ├── static
│       │       └── templates
│       └── test
├── springboot-webflux-demo(module4)
│   ├── pom.xml
│   ├── springboot-webflux-demo.iml
│   └── src
│       ├── main
│       │   ├── java
│       │   │   └── **
│       │   │       └── **
│       │   │           └── **
│       │   │               └── **
│       │   │                   └── **
│       │   │                       └── **.java
│       │   └── resources
│       │       └── application.yml⑤
│       └── test
└────.apifox-uploader.config⑥

上述结构中:#

①: 只对java(module1)生效
②: 如果开启了默认推荐配置的话,默认会加载,所以其中的参数可以在③中通过{property}来使用
③: 只对kotlin(module2)生效
④/⑤: 与②一样application.properties/application.yml/application.yaml都可以被加载
⑥: 对java(module1)/kotlin(module2)/springboot-demo(module3)/springboot-webflux-demo(module4)都生效
①/③/④/⑤/⑥均为可选配置.
上一页
如何使用配置?
下一页
其他
Built with