可用配置规则
EasyYapi 提供了丰富的配置规则来自定义 API 文档生成。
规则格式
规则以键值对的形式定义在配置文件中：
properties
rule.key=rule_value部分规则支持 Groovy 脚本进行高级自定义：
properties
rule.key=groovy:'''
// Groovy 脚本
it.name() + " - 自定义后缀"
'''API 规则
| 规则 | 说明 |
|---|---|
| api.name | 设置 API 名称 |
| api.open | 设置 API 是否公开 |
| api.status | 设置 API 状态 |
| api.tag | 设置 API 标签 |
类规则
| 规则 | 说明 |
|---|---|
| class.doc | 设置类文档 |
| class.is.ctrl | 判断是否为控制器（class.is.spring.ctrl 的别名） |
| class.is.spring.ctrl | 判断是否为 Spring 控制器 |
| class.is.feign.ctrl | 判断是否为 Feign 客户端 |
| class.is.jaxrs.ctrl | 判断是否为 JAX-RS 资源 |
| class.is.quarkus.ctrl | 判断是否为 Quarkus 资源 |
| class.is.grpc | 判断是否为 gRPC 服务 |
| class.prefix.path | 设置类前缀路径 |
字段规则
| 规则 | 说明 |
|---|---|
| field.default.value | 设置字段默认值 |
| field.demo | 设置字段示例值 |
| field.doc | 设置字段文档 |
| field.ignore | 忽略字段 |
| field.mock | 设置字段 Mock 值 |
| field.name | 设置字段名称 |
| field.name.prefix | 设置字段名称前缀 |
| field.name.suffix | 设置字段名称后缀 |
| field.required | 设置字段是否必填 |
| field.order | 设置字段顺序 |
| field.order.with | 设置字段排序比较器 |
| field.advanced | 设置字段高级信息 |
| field.max.depth | 设置字段最大递归深度 |
方法规则
| 规则 | 说明 |
|---|---|
| method.doc | 设置方法文档 |
| method.return | 设置方法返回类型 |
| method.return.main | 指定 @return 文档注释放置的字段 |
| method.content.type | 设置内容类型 |
| method.default.http.method | 设置默认 HTTP 方法 |
| method.additional.header | 添加额外请求头 |
| method.additional.param | 添加额外参数 |
| method.additional.response.header | 添加额外响应头 |
参数规则
| 规则 | 说明 |
|---|---|
| param.default.value | 设置参数默认值 |
| param.demo | 设置参数示例值 |
| param.doc | 设置参数文档 |
| param.http.type | 设置参数 HTTP 类型 |
| param.ignore | 忽略参数 |
| param.name | 设置参数名称 |
| param.required | 设置参数是否必填 |
| param.type | 设置参数类型 |
| param.mock | 设置参数 Mock 值 |
| param.max.depth | 设置参数最大递归深度 |
枚举规则
| 规则 | 说明 |
|---|---|
| enum.use.custom | 自定义枚举值 |
JSON 规则
| 规则 | 说明 |
|---|---|
| json.rule.convert | 类型转换 |
| json.additional.field | 添加额外字段 |
| json.unwrapped | 处理 @JsonUnwrapped |
其他规则
| 规则 | 说明 |
|---|---|
| folder.name | 设置文件夹名称 |
| module | 设置模块名称（yapi.project 的别名） |
| ignore | 忽略 API |
| path.multi | 多路径支持 |
| export.after | 导出后回调 |
| http.call.before | 请求前回调 |
| http.call.after | 请求后回调 |
| constant.field.ignore | 忽略常量字段 |
| endpoint.prefix.path | 设置端点前缀路径 |
Postman 规则
| 规则 | 说明 |
|---|---|
| postman.host | 设置 Postman 基础 URL |
| postman.prerequest | 前置请求脚本 |
| postman.test | 测试脚本 |
| postman.class.prerequest | 类级别前置请求脚本 |
| postman.class.test | 类级别测试脚本 |
| postman.collection.prerequest | 集合级别前置请求事件 |
| postman.collection.test | 集合级别测试事件 |
| postman.format.after | 格式化后事件 |
YApi 规则
| 规则 | 说明 |
|---|---|
| yapi.project | 设置 YApi 项目 |
| yapi.export.before | 导出前事件 |
| yapi.save.before | 保存前事件 |
| yapi.save.after | 保存后事件 |