Files
data-engine/report-engine-openapi.json
T
2026-07-02 10:23:07 +08:00

4849 lines
131 KiB
JSON

{
"openapi": "3.0.0",
"components": {
"schemas": {
"dataengine.model.dto.dict.CreateApiInterfaceReq": {
"description": "创建新的数据接口",
"properties": {
"platformId": {
"description": "所属平台ID",
"format": "int64",
"type": "integer"
},
"name": {
"description": "接口名称",
"format": "string",
"type": "string"
},
"code": {
"description": "接口编码",
"format": "string",
"type": "string"
},
"url": {
"description": "接口地址",
"format": "string",
"type": "string"
},
"method": {
"description": "请求方法",
"format": "api_feature.ApiMethod",
"type": "string"
},
"status": {
"default": "active",
"description": "接口状态",
"format": "api_feature.PlatformStatus",
"type": "string"
},
"authType": {
"description": "认证类型",
"format": "string",
"type": "string"
},
"requestConfig": {
"additionalProperties": {
"$ref": "#/components/schemas/interface",
"description": ""
},
"description": "请求配置",
"format": "map[string]interface {}",
"type": "object"
},
"responseConfig": {
"additionalProperties": {
"$ref": "#/components/schemas/interface",
"description": ""
},
"description": "响应配置",
"format": "map[string]interface {}",
"type": "object"
},
"limitConfig": {
"additionalProperties": {
"$ref": "#/components/schemas/interface",
"description": ""
},
"description": "接口独立限流配置",
"format": "map[string]interface {}",
"type": "object"
},
"tableDefinition": {
"additionalProperties": {
"$ref": "#/components/schemas/interface",
"description": ""
},
"description": "表结构定义(JSON),用于自动建表",
"format": "map[string]interface {}",
"type": "object"
}
},
"required": [
"platformId",
"name",
"code",
"url",
"method"
],
"type": "object"
},
"interface": {
"properties": {},
"type": "object"
},
"dataengine.model.dto.dict.CreateApiInterfaceRes": {
"properties": {
"id": {
"description": "接口ID",
"format": "int64",
"type": "integer"
}
},
"type": "object"
},
"dataengine.model.dto.dict.DeleteApiInterfaceReq": {
"description": "删除接口",
"properties": {
"id": {
"description": "接口ID",
"format": "int64",
"type": "integer"
}
},
"required": [
"id"
],
"type": "object"
},
"gitea.redpowerfuture.com.red-future.common.beans.ResponseEmpty": {
"properties": {},
"type": "object"
},
"dataengine.model.dto.dict.GetApiInterfaceReq": {
"description": "获取接口详情",
"properties": {
"id": {
"description": "接口ID",
"format": "int64",
"type": "integer"
}
},
"required": [
"id"
],
"type": "object"
},
"dataengine.model.dto.dict.GetApiInterfaceRes": {
"properties": {
"id": {
"format": "int64",
"type": "integer"
},
"tenantId": {
"format": "uint64",
"type": "integer"
},
"creator": {
"format": "string",
"type": "string"
},
"createdAt": {
"format": "*gtime.Time",
"type": "string"
},
"updater": {
"format": "string",
"type": "string"
},
"updatedAt": {
"format": "*gtime.Time",
"type": "string"
},
"deletedAt": {
"format": "*gtime.Time",
"type": "string"
},
"platformId": {
"description": "所属平台ID",
"format": "int64",
"type": "integer"
},
"name": {
"description": "接口名称",
"format": "string",
"type": "string"
},
"code": {
"description": "接口编码",
"format": "string",
"type": "string"
},
"url": {
"description": "接口地址",
"format": "string",
"type": "string"
},
"method": {
"description": "请求方法:GET/POST/PUT/DELETE等",
"format": "api_feature.ApiMethod",
"type": "string"
},
"status": {
"description": "接口状态:active启用/inactive停用",
"format": "api_feature.PlatformStatus",
"type": "string"
},
"authType": {
"description": "认证类型:oauth2/apikey/basic等",
"format": "string",
"type": "string"
},
"requestConfig": {
"additionalProperties": {
"$ref": "#/components/schemas/interface",
"description": ""
},
"description": "请求配置",
"format": "map[string]interface {}",
"type": "object"
},
"responseConfig": {
"additionalProperties": {
"$ref": "#/components/schemas/interface",
"description": ""
},
"description": "响应配置",
"format": "map[string]interface {}",
"type": "object"
},
"limitConfig": {
"additionalProperties": {
"$ref": "#/components/schemas/interface",
"description": ""
},
"description": "接口独立限流配置(可选,覆盖平台配置)",
"format": "map[string]interface {}",
"type": "object"
},
"tableDefinition": {
"additionalProperties": {
"$ref": "#/components/schemas/interface",
"description": ""
},
"description": "表结构定义,用于自动建表",
"format": "map[string]interface {}",
"type": "object"
},
"platformName": {
"format": "string",
"type": "string"
}
},
"type": "object"
},
"dataengine.model.dto.dict.ListApiInterfaceReq": {
"description": "分页查询接口列表",
"properties": {
"pageNum": {
"format": "int64",
"type": "integer"
},
"pageSize": {
"format": "int64",
"type": "integer"
},
"Total": {
"format": "int64",
"type": "integer"
},
"platformId": {
"description": "平台ID",
"format": "int64",
"type": "integer"
},
"name": {
"description": "接口名称",
"format": "string",
"type": "string"
},
"code": {
"description": "接口编码",
"format": "string",
"type": "string"
},
"method": {
"description": "请求方法",
"format": "api_feature.ApiMethod",
"type": "string"
},
"status": {
"description": "接口状态",
"format": "api_feature.PlatformStatus",
"type": "string"
},
"keyword": {
"description": "关键字(搜索名称或编码)",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"dataengine.model.dto.dict.ListApiInterfaceRes": {
"properties": {
"list": {
"description": "接口列表",
"format": "[]dict.ApiInterfaceItem",
"items": {
"$ref": "#/components/schemas/dataengine.model.dto.dict.ApiInterfaceItem",
"description": ""
},
"type": "array"
},
"total": {
"description": "总数",
"format": "int",
"type": "integer"
}
},
"type": "object"
},
"dataengine.model.dto.dict.ApiInterfaceItem": {
"properties": {
"id": {
"format": "int64",
"type": "integer"
},
"platformId": {
"format": "int64",
"type": "integer"
},
"platformName": {
"format": "string",
"type": "string"
},
"name": {
"format": "string",
"type": "string"
},
"code": {
"format": "string",
"type": "string"
},
"url": {
"format": "string",
"type": "string"
},
"method": {
"format": "api_feature.ApiMethod",
"type": "string"
},
"status": {
"format": "api_feature.PlatformStatus",
"type": "string"
},
"statusName": {
"format": "string",
"type": "string"
},
"createdBy": {
"format": "string",
"type": "string"
},
"createdAt": {
"format": "int64",
"type": "integer"
},
"updatedBy": {
"format": "string",
"type": "string"
},
"updatedAt": {
"format": "int64",
"type": "integer"
}
},
"type": "object"
},
"dataengine.model.dto.dict.UpdateApiInterfaceReq": {
"description": "更新接口信息",
"properties": {
"id": {
"description": "接口ID",
"format": "int64",
"type": "integer"
},
"platformId": {
"description": "所属平台ID",
"format": "int64",
"type": "integer"
},
"name": {
"description": "接口名称",
"format": "string",
"type": "string"
},
"code": {
"description": "接口编码",
"format": "string",
"type": "string"
},
"url": {
"description": "接口地址",
"format": "string",
"type": "string"
},
"method": {
"description": "请求方法",
"format": "api_feature.ApiMethod",
"type": "string"
},
"status": {
"description": "接口状态",
"format": "api_feature.PlatformStatus",
"type": "string"
},
"authType": {
"description": "认证类型",
"format": "string",
"type": "string"
},
"requestConfig": {
"additionalProperties": {
"$ref": "#/components/schemas/interface",
"description": ""
},
"description": "请求配置",
"format": "map[string]interface {}",
"type": "object"
},
"responseConfig": {
"additionalProperties": {
"$ref": "#/components/schemas/interface",
"description": ""
},
"description": "响应配置",
"format": "map[string]interface {}",
"type": "object"
},
"limitConfig": {
"additionalProperties": {
"$ref": "#/components/schemas/interface",
"description": ""
},
"description": "接口独立限流配置",
"format": "map[string]interface {}",
"type": "object"
},
"tableDefinition": {
"additionalProperties": {
"$ref": "#/components/schemas/interface",
"description": ""
},
"description": "表结构定义(JSON),用于自动建表",
"format": "map[string]interface {}",
"type": "object"
}
},
"required": [
"id"
],
"type": "object"
},
"dataengine.model.dto.dict.UpdateApiInterfaceStatusReq": {
"description": "更新接口状态",
"properties": {
"id": {
"description": "接口ID",
"format": "int64",
"type": "integer"
},
"status": {
"description": "状态:active启用/inactive停用",
"enum": [
"active",
"inactive"
],
"format": "api_feature.PlatformStatus",
"type": "string"
}
},
"required": [
"id",
"status"
],
"type": "object"
},
"dataengine.model.dto.dict.CreateDatasourcePlatformReq": {
"description": "创建新的数据源平台配置",
"properties": {
"platformCode": {
"description": "平台编码(唯一标识)",
"format": "string",
"type": "string"
},
"platformName": {
"description": "平台名称",
"format": "string",
"type": "string"
},
"description": {
"description": "平台描述",
"format": "string",
"type": "string"
},
"status": {
"default": "ACTIVE",
"description": "平台状态",
"format": "api_feature.PlatformStatus",
"type": "string"
},
"apiBaseUrl": {
"description": "API基础地址",
"format": "string",
"type": "string"
},
"authType": {
"description": "认证类型: TOKEN/API_KEY/OAUTH2/BASIC",
"enum": [
"TOKEN",
"API_KEY",
"OAUTH2",
"BASIC"
],
"format": "string",
"type": "string"
},
"token": {
"description": "认证token/密钥",
"format": "string",
"type": "string"
},
"apiKey": {
"description": "API Key",
"format": "string",
"type": "string"
},
"clientId": {
"description": "OAuth2 Client ID",
"format": "string",
"type": "string"
},
"clientSecret": {
"description": "OAuth2 Client Secret",
"format": "string",
"type": "string"
},
"rateLimitPerMinute": {
"default": 60,
"description": "每分钟请求限制",
"format": "int",
"type": "integer"
},
"rateLimitPerHour": {
"default": 1000,
"description": "每小时请求限制",
"format": "int",
"type": "integer"
},
"concurrencyLimit": {
"default": 10,
"description": "并发连接限制",
"format": "int",
"type": "integer"
},
"requestTimeoutMs": {
"default": 30000,
"description": "请求超时时间(毫秒)",
"format": "int",
"type": "integer"
},
"maxRetries": {
"default": 3,
"description": "最大重试次数",
"format": "int",
"type": "integer"
},
"retryDelayMs": {
"default": 1000,
"description": "重试延迟(毫秒)",
"format": "int",
"type": "integer"
},
"authConfig": {
"additionalProperties": {
"$ref": "#/components/schemas/interface",
"description": ""
},
"description": "自定义认证配置(JSON),支持各平台特有认证方式",
"format": "map[string]interface {}",
"type": "object"
}
},
"required": [
"platformCode",
"platformName",
"authType"
],
"type": "object"
},
"dataengine.model.dto.dict.CreateDatasourcePlatformRes": {
"properties": {
"id": {
"description": "平台ID",
"format": "int64",
"type": "integer"
}
},
"type": "object"
},
"dataengine.model.dto.dict.DeleteDatasourcePlatformReq": {
"description": "删除数据源平台",
"properties": {
"id": {
"description": "平台ID",
"format": "int64",
"type": "integer"
}
},
"required": [
"id"
],
"type": "object"
},
"dataengine.model.dto.dict.GetDatasourcePlatformReq": {
"description": "获取数据源平台详情",
"properties": {
"id": {
"description": "平台ID",
"format": "int64",
"type": "integer"
}
},
"required": [
"id"
],
"type": "object"
},
"dataengine.model.dto.dict.GetDatasourcePlatformRes": {
"properties": {
"id": {
"format": "int64",
"type": "integer"
},
"tenantId": {
"format": "uint64",
"type": "integer"
},
"creator": {
"format": "string",
"type": "string"
},
"createdAt": {
"format": "*gtime.Time",
"type": "string"
},
"updater": {
"format": "string",
"type": "string"
},
"updatedAt": {
"format": "*gtime.Time",
"type": "string"
},
"deletedAt": {
"format": "*gtime.Time",
"type": "string"
},
"platformCode": {
"description": "平台编码,唯一标识",
"format": "string",
"type": "string"
},
"platformName": {
"description": "平台名称",
"format": "string",
"type": "string"
},
"description": {
"description": "平台描述",
"format": "string",
"type": "string"
},
"status": {
"description": "状态: ACTIVE启用, INACTIVE停用",
"format": "string",
"type": "string"
},
"apiBaseUrl": {
"description": "API基础地址",
"format": "string",
"type": "string"
},
"authType": {
"description": "认证类型: TOKEN/API_KEY/OAUTH2/BASIC",
"format": "string",
"type": "string"
},
"token": {
"description": "认证token/密钥",
"format": "string",
"type": "string"
},
"apiKey": {
"description": "API Key",
"format": "string",
"type": "string"
},
"clientId": {
"description": "OAuth2 Client ID",
"format": "string",
"type": "string"
},
"clientSecret": {
"description": "OAuth2 Client Secret",
"format": "string",
"type": "string"
},
"rateLimitPerMinute": {
"description": "每分钟请求限制",
"format": "int",
"type": "integer"
},
"rateLimitPerHour": {
"description": "每小时请求限制",
"format": "int",
"type": "integer"
},
"concurrencyLimit": {
"description": "并发连接限制",
"format": "int",
"type": "integer"
},
"requestTimeoutMs": {
"description": "请求超时时间(毫秒)",
"format": "int",
"type": "integer"
},
"maxRetries": {
"description": "最大重试次数",
"format": "int",
"type": "integer"
},
"retryDelayMs": {
"description": "重试延迟(毫秒)",
"format": "int",
"type": "integer"
},
"authConfig": {
"additionalProperties": {
"$ref": "#/components/schemas/interface",
"description": ""
},
"description": "自定义认证配置,支持各平台特有的认证方式",
"format": "map[string]interface {}",
"type": "object"
},
"version": {
"description": "版本号(乐观锁)",
"format": "int",
"type": "integer"
}
},
"type": "object"
},
"dataengine.model.dto.dict.GetPlatformByCodeReq": {
"description": "根据平台编码获取平台配置信息",
"properties": {
"platformCode": {
"description": "平台编码",
"format": "string",
"type": "string"
}
},
"required": [
"platformCode"
],
"type": "object"
},
"dataengine.model.dto.dict.GetPlatformByCodeRes": {
"properties": {
"id": {
"format": "int64",
"type": "integer"
},
"tenantId": {
"format": "uint64",
"type": "integer"
},
"creator": {
"format": "string",
"type": "string"
},
"createdAt": {
"format": "*gtime.Time",
"type": "string"
},
"updater": {
"format": "string",
"type": "string"
},
"updatedAt": {
"format": "*gtime.Time",
"type": "string"
},
"deletedAt": {
"format": "*gtime.Time",
"type": "string"
},
"platformCode": {
"description": "平台编码,唯一标识",
"format": "string",
"type": "string"
},
"platformName": {
"description": "平台名称",
"format": "string",
"type": "string"
},
"description": {
"description": "平台描述",
"format": "string",
"type": "string"
},
"status": {
"description": "状态: ACTIVE启用, INACTIVE停用",
"format": "string",
"type": "string"
},
"apiBaseUrl": {
"description": "API基础地址",
"format": "string",
"type": "string"
},
"authType": {
"description": "认证类型: TOKEN/API_KEY/OAUTH2/BASIC",
"format": "string",
"type": "string"
},
"token": {
"description": "认证token/密钥",
"format": "string",
"type": "string"
},
"apiKey": {
"description": "API Key",
"format": "string",
"type": "string"
},
"clientId": {
"description": "OAuth2 Client ID",
"format": "string",
"type": "string"
},
"clientSecret": {
"description": "OAuth2 Client Secret",
"format": "string",
"type": "string"
},
"rateLimitPerMinute": {
"description": "每分钟请求限制",
"format": "int",
"type": "integer"
},
"rateLimitPerHour": {
"description": "每小时请求限制",
"format": "int",
"type": "integer"
},
"concurrencyLimit": {
"description": "并发连接限制",
"format": "int",
"type": "integer"
},
"requestTimeoutMs": {
"description": "请求超时时间(毫秒)",
"format": "int",
"type": "integer"
},
"maxRetries": {
"description": "最大重试次数",
"format": "int",
"type": "integer"
},
"retryDelayMs": {
"description": "重试延迟(毫秒)",
"format": "int",
"type": "integer"
},
"authConfig": {
"additionalProperties": {
"$ref": "#/components/schemas/interface",
"description": ""
},
"description": "自定义认证配置,支持各平台特有的认证方式",
"format": "map[string]interface {}",
"type": "object"
},
"version": {
"description": "版本号(乐观锁)",
"format": "int",
"type": "integer"
}
},
"type": "object"
},
"dataengine.model.dto.dict.GetPlatformStatisticsReq": {
"description": "获取数据源平台统计信息",
"properties": {},
"type": "object"
},
"dataengine.model.dto.dict.GetPlatformStatisticsRes": {
"properties": {
"totalPlatforms": {
"description": "总平台数",
"format": "int",
"type": "integer"
},
"activePlatforms": {
"description": "启用平台数",
"format": "int",
"type": "integer"
},
"inactivePlatforms": {
"description": "停用平台数",
"format": "int",
"type": "integer"
},
"tokenAuthPlatforms": {
"description": "TOKEN认证平台数",
"format": "int",
"type": "integer"
},
"apiKeyAuthPlatforms": {
"description": "API_KEY认证平台数",
"format": "int",
"type": "integer"
},
"oauth2AuthPlatforms": {
"description": "OAUTH2认证平台数",
"format": "int",
"type": "integer"
},
"basicAuthPlatforms": {
"description": "BASIC认证平台数",
"format": "int",
"type": "integer"
}
},
"type": "object"
},
"dataengine.model.dto.dict.ListDatasourcePlatformReq": {
"description": "分页查询数据源平台列表",
"properties": {
"pageNum": {
"format": "int64",
"type": "integer"
},
"pageSize": {
"format": "int64",
"type": "integer"
},
"Total": {
"format": "int64",
"type": "integer"
},
"platformCode": {
"description": "平台编码",
"format": "string",
"type": "string"
},
"platformName": {
"description": "平台名称",
"format": "string",
"type": "string"
},
"status": {
"description": "平台状态",
"format": "api_feature.PlatformStatus",
"type": "string"
},
"authType": {
"description": "认证类型",
"format": "string",
"type": "string"
},
"keyword": {
"description": "关键字(搜索平台名称或编码)",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"dataengine.model.dto.dict.ListDatasourcePlatformRes": {
"properties": {
"list": {
"description": "平台列表",
"format": "[]dict.DatasourcePlatformItem",
"items": {
"$ref": "#/components/schemas/dataengine.model.dto.dict.DatasourcePlatformItem",
"description": ""
},
"type": "array"
},
"total": {
"description": "总数",
"format": "int",
"type": "integer"
}
},
"type": "object"
},
"dataengine.model.dto.dict.DatasourcePlatformItem": {
"properties": {
"id": {
"format": "int64",
"type": "integer"
},
"tenantId": {
"format": "uint64",
"type": "integer"
},
"platformCode": {
"format": "string",
"type": "string"
},
"platformName": {
"format": "string",
"type": "string"
},
"description": {
"format": "string",
"type": "string"
},
"status": {
"format": "api_feature.PlatformStatus",
"type": "string"
},
"statusName": {
"format": "string",
"type": "string"
},
"apiBaseUrl": {
"format": "string",
"type": "string"
},
"authType": {
"format": "string",
"type": "string"
},
"authTypeName": {
"format": "string",
"type": "string"
},
"rateLimitPerMinute": {
"format": "int",
"type": "integer"
},
"rateLimitPerHour": {
"format": "int",
"type": "integer"
},
"concurrencyLimit": {
"format": "int",
"type": "integer"
},
"requestTimeoutMs": {
"format": "int",
"type": "integer"
},
"maxRetries": {
"format": "int",
"type": "integer"
},
"retryDelayMs": {
"format": "int",
"type": "integer"
},
"createdBy": {
"format": "string",
"type": "string"
},
"createdAt": {
"format": "int64",
"type": "integer"
},
"updatedBy": {
"format": "string",
"type": "string"
},
"updatedAt": {
"format": "int64",
"type": "integer"
}
},
"type": "object"
},
"dataengine.model.dto.dict.UpdateDatasourcePlatformReq": {
"description": "更新数据源平台配置",
"properties": {
"id": {
"description": "平台ID",
"format": "int64",
"type": "integer"
},
"platformCode": {
"description": "平台编码",
"format": "string",
"type": "string"
},
"platformName": {
"description": "平台名称",
"format": "string",
"type": "string"
},
"description": {
"description": "平台描述",
"format": "string",
"type": "string"
},
"status": {
"description": "平台状态",
"format": "api_feature.PlatformStatus",
"type": "string"
},
"apiBaseUrl": {
"description": "API基础地址",
"format": "string",
"type": "string"
},
"authType": {
"description": "认证类型",
"format": "string",
"type": "string"
},
"token": {
"description": "认证token/密钥",
"format": "string",
"type": "string"
},
"apiKey": {
"description": "API Key",
"format": "string",
"type": "string"
},
"clientId": {
"description": "OAuth2 Client ID",
"format": "string",
"type": "string"
},
"clientSecret": {
"description": "OAuth2 Client Secret",
"format": "string",
"type": "string"
},
"rateLimitPerMinute": {
"description": "每分钟请求限制",
"format": "int",
"type": "integer"
},
"rateLimitPerHour": {
"description": "每小时请求限制",
"format": "int",
"type": "integer"
},
"concurrencyLimit": {
"description": "并发连接限制",
"format": "int",
"type": "integer"
},
"requestTimeoutMs": {
"description": "请求超时时间(毫秒)",
"format": "int",
"type": "integer"
},
"maxRetries": {
"description": "最大重试次数",
"format": "int",
"type": "integer"
},
"retryDelayMs": {
"description": "重试延迟(毫秒)",
"format": "int",
"type": "integer"
},
"authConfig": {
"additionalProperties": {
"$ref": "#/components/schemas/interface",
"description": ""
},
"description": "自定义认证配置(JSON)",
"format": "map[string]interface {}",
"type": "object"
}
},
"required": [
"id"
],
"type": "object"
},
"dataengine.model.dto.dict.UpdateDatasourcePlatformStatusReq": {
"description": "更新数据源平台状态",
"properties": {
"id": {
"description": "平台ID",
"format": "int64",
"type": "integer"
},
"status": {
"description": "状态:ACTIVE启用/INACTIVE停用",
"enum": [
"ACTIVE",
"INACTIVE"
],
"format": "api_feature.PlatformStatus",
"type": "string"
}
},
"required": [
"id",
"status"
],
"type": "object"
},
"dataengine.controller.public.ClearCacheReq": {
"properties": {},
"type": "object"
},
"dataengine.model.dto.public.TableListRes": {
"properties": {
"list": {
"description": "表列表",
"format": "[]public.TableInfo",
"items": {
"$ref": "#/components/schemas/dataengine.model.dto.public.TableInfo",
"description": ""
},
"type": "array"
}
},
"type": "object"
},
"dataengine.model.dto.public.TableInfo": {
"properties": {
"tableName": {
"description": "表名",
"format": "string",
"type": "string"
},
"platformName": {
"description": "平台名称",
"format": "string",
"type": "string"
},
"interfaceName": {
"description": "接口名称",
"format": "string",
"type": "string"
},
"columns": {
"description": "可用字段列表",
"format": "[]string",
"items": {
"format": "string",
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"dataengine.model.dto.public.QueryReq": {
"description": "支持字段/表名/过滤/分组/分页的通用查询接口",
"properties": {
"table": {
"description": "表名(白名单限制)",
"format": "string",
"type": "string"
},
"fields": {
"description": "查询字段,逗号分隔,默认 *",
"format": "string",
"type": "string"
},
"where": {
"additionalProperties": {
"$ref": "#/components/schemas/interface",
"description": ""
},
"description": "过滤条件,支持操作符: =, !=, >, <, >=, <=, like, in, between",
"format": "map[string]interface {}",
"type": "object"
},
"groupBy": {
"description": "分组字段,逗号分隔",
"format": "string",
"type": "string"
},
"orderBy": {
"description": "排序字段,如: create_time desc",
"format": "string",
"type": "string"
},
"page": {
"default": 1,
"description": "页码,默认1",
"format": "int",
"type": "integer"
},
"pageSize": {
"default": 20,
"description": "每页条数,默认20,最大100",
"format": "int",
"type": "integer"
}
},
"required": [
"table"
],
"type": "object"
},
"dataengine.model.dto.public.QueryRes": {
"properties": {
"list": {
"description": "数据列表",
"format": "[]map[string]interface {}",
"items": {
"additionalProperties": {
"$ref": "#/components/schemas/interface",
"description": ""
},
"format": "map[string]interface {}",
"type": "object"
},
"type": "array"
},
"total": {
"description": "总数",
"format": "int64",
"type": "integer"
},
"page": {
"description": "当前页码",
"format": "int",
"type": "integer"
},
"size": {
"description": "每页条数",
"format": "int",
"type": "integer"
}
},
"type": "object"
},
"dataengine.model.dto.public.TableListReq": {
"description": "获取配置了表结构的同步表列表",
"properties": {},
"type": "object"
},
"dataengine.model.dto.public.ColumnListReq": {
"description": "获取指定表的字段列表",
"properties": {
"table": {
"description": "表名",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"dataengine.model.dto.public.ColumnListRes": {
"properties": {
"tableName": {
"description": "表名",
"format": "string",
"type": "string"
},
"columns": {
"description": "字段列表",
"format": "[]public.Column",
"items": {
"$ref": "#/components/schemas/dataengine.model.dto.public.Column",
"description": ""
},
"type": "array"
}
},
"type": "object"
},
"dataengine.model.dto.public.Column": {
"properties": {
"name": {
"description": "字段名",
"format": "string",
"type": "string"
},
"type": {
"description": "字段类型",
"format": "string",
"type": "string"
},
"comment": {
"description": "字段说明",
"format": "string",
"type": "string"
}
},
"type": "object"
},
"dataengine.controller.report.autoCreateTableReq": {
"properties": {
"businessCode": {
"description": "业务编码",
"format": "string",
"type": "string"
},
"reportCode": {
"description": "报表编码",
"format": "string",
"type": "string"
},
"creator": {
"description": "创建人",
"format": "string",
"type": "string"
}
},
"required": [
"businessCode",
"reportCode"
],
"type": "object",
"example": {
"businessCode": "KUAISHOU",
"reportCode": "shop_daily",
"creator": "admin"
}
},
"dataengine.common.report.model.AutoCreateStatTableResp": {
"properties": {
"success": {
"description": "是否成功",
"format": "bool",
"type": "boolean"
},
"tableName": {
"description": "创建的表名",
"format": "string",
"type": "string"
},
"columnCount": {
"description": "字段数量",
"format": "int",
"type": "integer"
},
"execTimeMs": {
"description": "执行耗时(毫秒)",
"format": "int64",
"type": "integer"
}
},
"type": "object"
},
"dataengine.controller.report.backfillReq": {
"properties": {
"businessCode": {
"description": "业务编码",
"format": "string",
"type": "string"
},
"reportCode": {
"description": "报表编码",
"format": "string",
"type": "string"
},
"startDate": {
"description": "开始日期 yyyy-MM-dd",
"format": "string",
"type": "string"
},
"endDate": {
"description": "结束日期 yyyy-MM-dd",
"format": "string",
"type": "string"
},
"executor": {
"description": "执行人",
"format": "string",
"type": "string"
}
},
"required": [
"businessCode",
"reportCode",
"startDate",
"endDate"
],
"type": "object",
"example": {
"businessCode": "KUAISHOU",
"reportCode": "shop_daily",
"startDate": "2026-06-01",
"endDate": "2026-06-17",
"executor": "admin"
}
},
"dataengine.common.report.model.BackfillResp": {
"properties": {
"success": {
"description": "是否全部成功",
"format": "bool",
"type": "boolean"
},
"totalDays": {
"description": "总天数",
"format": "int",
"type": "integer"
},
"successDays": {
"description": "成功天数",
"format": "int",
"type": "integer"
},
"failDays": {
"description": "失败天数",
"format": "int",
"type": "integer"
},
"execTimeMs": {
"description": "总耗时(毫秒)",
"format": "int64",
"type": "integer"
},
"errorMsg": {
"description": "错误信息",
"format": "string",
"type": "string"
}
},
"type": "object",
"example": {
"success": true,
"totalDays": 30,
"successDays": 30,
"execTimeMs": 95000
}
},
"dataengine.controller.report.deleteBusinessReq": {
"properties": {
"id": {
"format": "int64",
"type": "integer"
}
},
"required": [
"id"
],
"type": "object"
},
"dataengine.controller.report.deleteBusinessRes": {
"properties": {
"success": {
"format": "bool",
"type": "boolean"
},
"message": {
"format": "string",
"type": "string"
}
},
"type": "object"
},
"dataengine.controller.report.getBusinessReq": {
"properties": {
"id": {
"format": "int64",
"type": "integer"
}
},
"required": [
"id"
],
"type": "object"
},
"dataengine.controller.report.getBusinessRes": {
"properties": {
"data": {
"$ref": "#/components/schemas/dataengine.common.report.model.BusinessConfig",
"description": ""
}
},
"type": "object"
},
"dataengine.common.report.model.BusinessConfig": {
"properties": {
"id": {
"format": "int64",
"type": "integer"
},
"tenantId": {
"format": "uint64",
"type": "integer"
},
"creator": {
"format": "string",
"type": "string"
},
"createdAt": {
"format": "*gtime.Time",
"type": "string"
},
"updater": {
"format": "string",
"type": "string"
},
"updatedAt": {
"format": "*gtime.Time",
"type": "string"
},
"deletedAt": {
"format": "*gtime.Time",
"type": "string"
},
"businessCode": {
"format": "string",
"type": "string"
},
"businessName": {
"format": "string",
"type": "string"
},
"description": {
"format": "string",
"type": "string"
},
"status": {
"format": "string",
"type": "string"
},
"config": {
"additionalProperties": {
"$ref": "#/components/schemas/interface",
"description": ""
},
"format": "map[string]interface {}",
"type": "object"
}
},
"type": "object",
"example": {
"id": 1,
"businessCode": "KUAISHOU",
"businessName": "快手电商",
"status": "ACTIVE"
}
},
"dataengine.controller.report.saveBusinessReq": {
"properties": {
"id": {
"format": "*int64",
"type": "integer"
},
"businessCode": {
"description": "业务编码",
"format": "string",
"type": "string"
},
"businessName": {
"description": "业务名称",
"format": "string",
"type": "string"
},
"description": {
"description": "描述",
"format": "string",
"type": "string"
},
"status": {
"default": "ACTIVE",
"description": "状态 ACTIVE/INACTIVE",
"format": "string",
"type": "string"
},
"config": {
"additionalProperties": {
"$ref": "#/components/schemas/interface",
"description": ""
},
"description": "扩展配置",
"format": "map[string]interface {}",
"type": "object"
}
},
"required": [
"businessCode",
"businessName"
],
"type": "object",
"example": {
"id": null,
"businessCode": "KUAISHOU",
"businessName": "快手电商",
"description": "快手电商业务",
"status": "ACTIVE",
"config": {
"sourceSystem": "kuaishou",
"owner": "data-team"
}
}
},
"dataengine.controller.report.saveBusinessRes": {
"properties": {
"success": {
"format": "bool",
"type": "boolean"
},
"id": {
"format": "int64",
"type": "integer"
},
"message": {
"format": "string",
"type": "string"
}
},
"type": "object"
},
"dataengine.controller.report.listBusinessesReq": {
"properties": {},
"type": "object"
},
"dataengine.controller.report.listBusinessesRes": {
"properties": {
"list": {
"format": "[]model.BusinessConfig",
"items": {
"$ref": "#/components/schemas/dataengine.common.report.model.BusinessConfig",
"description": ""
},
"type": "array"
}
},
"type": "object"
},
"dataengine.controller.report.extractDataReq": {
"properties": {
"businessCode": {
"description": "业务编码",
"format": "string",
"type": "string"
},
"reportCode": {
"description": "报表编码",
"format": "string",
"type": "string"
},
"statDate": {
"description": "统计日期 yyyy-MM-dd",
"format": "string",
"type": "string"
},
"executor": {
"description": "执行人",
"format": "string",
"type": "string"
}
},
"required": [
"businessCode",
"reportCode",
"statDate"
],
"type": "object",
"example": {
"businessCode": "KUAISHOU",
"reportCode": "shop_daily",
"statDate": "2026-06-17",
"executor": "admin"
}
},
"dataengine.common.report.model.ExtractDailyDataResp": {
"properties": {
"success": {
"description": "是否成功",
"format": "bool",
"type": "boolean"
},
"totalCount": {
"description": "总记录数",
"format": "int",
"type": "integer"
},
"successCount": {
"description": "成功记录数",
"format": "int",
"type": "integer"
},
"failCount": {
"description": "失败记录数",
"format": "int",
"type": "integer"
},
"execTimeMs": {
"description": "执行耗时(毫秒)",
"format": "int64",
"type": "integer"
},
"errorMsg": {
"description": "错误信息",
"format": "string",
"type": "string"
}
},
"type": "object",
"example": {
"success": true,
"totalCount": 31,
"successCount": 31,
"execTimeMs": 3200
}
},
"dataengine.controller.report.deleteExtractConfigReq": {
"properties": {
"id": {
"format": "int64",
"type": "integer"
}
},
"required": [
"id"
],
"type": "object"
},
"dataengine.controller.report.deleteExtractConfigRes": {
"properties": {
"success": {
"format": "bool",
"type": "boolean"
},
"message": {
"format": "string",
"type": "string"
}
},
"type": "object"
},
"dataengine.controller.report.getExtractConfigReq": {
"properties": {
"id": {
"format": "int64",
"type": "integer"
}
},
"required": [
"id"
],
"type": "object"
},
"dataengine.controller.report.getExtractConfigRes": {
"properties": {
"data": {
"$ref": "#/components/schemas/dataengine.common.report.model.ExtractConfig",
"description": ""
}
},
"type": "object"
},
"dataengine.common.report.model.ExtractConfig": {
"properties": {
"id": {
"format": "int64",
"type": "integer"
},
"tenantId": {
"format": "uint64",
"type": "integer"
},
"creator": {
"format": "string",
"type": "string"
},
"createdAt": {
"format": "*gtime.Time",
"type": "string"
},
"updater": {
"format": "string",
"type": "string"
},
"updatedAt": {
"format": "*gtime.Time",
"type": "string"
},
"deletedAt": {
"format": "*gtime.Time",
"type": "string"
},
"businessCode": {
"format": "string",
"type": "string"
},
"reportCode": {
"format": "string",
"type": "string"
},
"extractCode": {
"format": "string",
"type": "string"
},
"extractName": {
"format": "string",
"type": "string"
},
"sourceTableName": {
"format": "string",
"type": "string"
},
"sourceTableAlias": {
"format": "string",
"type": "string"
},
"targetTableName": {
"format": "string",
"type": "string"
},
"isEnabled": {
"format": "bool",
"type": "boolean"
},
"extractType": {
"format": "string",
"type": "string"
},
"extractMode": {
"format": "string",
"type": "string"
},
"extractKeyField": {
"format": "string",
"type": "string"
},
"extractKeyFormat": {
"format": "string",
"type": "string"
},
"groupByFields": {
"format": "[]string",
"items": {
"format": "string",
"type": "string"
},
"type": "array"
},
"filterExpression": {
"format": "string",
"type": "string"
},
"joinConfigs": {
"format": "[]model.JoinConfig",
"items": {
"$ref": "#/components/schemas/dataengine.common.report.model.JoinConfig",
"description": ""
},
"type": "array"
},
"fieldMappings": {
"format": "[]model.FieldMapping",
"items": {
"$ref": "#/components/schemas/dataengine.common.report.model.FieldMapping",
"description": ""
},
"type": "array"
},
"transformRules": {
"format": "[]model.TransformRule",
"items": {
"$ref": "#/components/schemas/dataengine.common.report.model.TransformRule",
"description": ""
},
"type": "array"
},
"batchSize": {
"format": "int",
"type": "integer"
},
"status": {
"format": "string",
"type": "string"
}
},
"type": "object",
"example": {
"id": 1,
"businessCode": "KUAISHOU",
"reportCode": "shop_daily",
"extractCode": "shop_daily_direct",
"extractName": "店铺日订单",
"extractMode": "DIRECT"
}
},
"dataengine.common.report.model.JoinConfig": {
"properties": {
"joinTable": {
"format": "string",
"type": "string"
},
"joinAlias": {
"format": "string",
"type": "string"
},
"joinType": {
"format": "string",
"type": "string"
},
"joinCondition": {
"format": "string",
"type": "string"
},
"fieldMappings": {
"format": "[]model.FieldMapping",
"items": {
"$ref": "#/components/schemas/dataengine.common.report.model.FieldMapping",
"description": ""
},
"type": "array"
}
},
"type": "object"
},
"dataengine.common.report.model.FieldMapping": {
"properties": {
"sourceField": {
"format": "string",
"type": "string"
},
"targetField": {
"format": "string",
"type": "string"
},
"fieldType": {
"format": "string",
"type": "string"
},
"aggregateFunction": {
"format": "string",
"type": "string"
},
"defaultValue": {
"$ref": "#/components/schemas/interface",
"description": ""
},
"transformRule": {
"$ref": "#/components/schemas/dataengine.common.report.model.TransformRule",
"description": ""
}
},
"type": "object"
},
"dataengine.common.report.model.TransformRule": {
"properties": {
"ruleCode": {
"format": "string",
"type": "string"
},
"ruleType": {
"format": "string",
"type": "string"
},
"expression": {
"format": "string",
"type": "string"
},
"format": {
"format": "string",
"type": "string"
},
"mapping": {
"additionalProperties": {
"$ref": "#/components/schemas/interface",
"description": ""
},
"format": "map[string]interface {}",
"type": "object"
}
},
"type": "object"
},
"dataengine.controller.report.saveExtractConfigReq": {
"properties": {
"id": {
"format": "*int64",
"type": "integer"
},
"businessCode": {
"description": "业务编码",
"format": "string",
"type": "string"
},
"reportCode": {
"description": "报表编码",
"format": "string",
"type": "string"
},
"extractCode": {
"description": "抽取编码",
"format": "string",
"type": "string"
},
"extractName": {
"description": "抽取名称",
"format": "string",
"type": "string"
},
"sourceTableName": {
"description": "源表名",
"format": "string",
"type": "string"
},
"sourceTableAlias": {
"description": "源表别名",
"format": "string",
"type": "string"
},
"targetTableName": {
"description": "目标表名",
"format": "string",
"type": "string"
},
"isEnabled": {
"default": true,
"description": "是否启用",
"format": "bool",
"type": "boolean"
},
"extractType": {
"default": "INCREMENTAL",
"description": "抽取类型 FULL/INCREMENTAL",
"format": "string",
"type": "string"
},
"extractMode": {
"default": "DIRECT",
"description": "抽取模式 DIRECT/AGGREGATE",
"format": "string",
"type": "string"
},
"extractKeyField": {
"description": "抽取关键字段(增量依据)",
"format": "string",
"type": "string"
},
"extractKeyFormat": {
"description": "关键字段格式",
"format": "string",
"type": "string"
},
"groupByFields": {
"description": "GROUP BY 字段列表",
"format": "[]string",
"items": {
"format": "string",
"type": "string"
},
"type": "array"
},
"filterExpression": {
"description": "过滤表达式",
"format": "string",
"type": "string"
},
"joinConfigs": {
"description": "JOIN配置",
"format": "[]model.JoinConfig",
"items": {
"$ref": "#/components/schemas/dataengine.common.report.model.JoinConfig",
"description": ""
},
"type": "array"
},
"fieldMappings": {
"description": "字段映射列表",
"format": "[]model.FieldMapping",
"items": {
"$ref": "#/components/schemas/dataengine.common.report.model.FieldMapping",
"description": ""
},
"type": "array"
},
"transformRules": {
"description": "转换规则列表",
"format": "[]model.TransformRule",
"items": {
"$ref": "#/components/schemas/dataengine.common.report.model.TransformRule",
"description": ""
},
"type": "array"
},
"batchSize": {
"default": 1000,
"description": "批处理大小",
"format": "int",
"type": "integer"
},
"status": {
"default": "ACTIVE",
"description": "状态",
"format": "string",
"type": "string"
}
},
"required": [
"businessCode",
"reportCode",
"extractCode",
"extractName",
"sourceTableName",
"targetTableName"
],
"type": "object",
"example": {
"id": 9,
"businessCode": "KUAISHOU",
"reportCode": "shop_daily",
"extractCode": "shop_daily_direct",
"extractName": "店铺日订单(逐行,可自由组合查询)",
"sourceTableName": "demo_kuaishou_orders",
"sourceTableAlias": "o",
"targetTableName": "stat_kuaishou_shop_daily",
"isEnabled": true,
"extractType": "INCREMENTAL",
"extractMode": "DIRECT",
"extractKeyField": "created_at",
"extractKeyFormat": "yyyy-MM-dd",
"groupByFields": [],
"filterExpression": "o.order_status = '已完成'",
"fieldMappings": [],
"joinConfigs": [],
"transformRules": [],
"batchSize": 1000,
"status": "ACTIVE"
}
},
"dataengine.controller.report.saveExtractConfigRes": {
"properties": {
"success": {
"format": "bool",
"type": "boolean"
},
"id": {
"format": "int64",
"type": "integer"
},
"message": {
"format": "string",
"type": "string"
}
},
"type": "object"
},
"dataengine.controller.report.getExtractConfigsReq": {
"properties": {
"businessCode": {
"format": "string",
"type": "string"
},
"reportCode": {
"format": "string",
"type": "string"
}
},
"required": [
"businessCode",
"reportCode"
],
"type": "object"
},
"dataengine.controller.report.getExtractConfigsRes": {
"properties": {
"list": {
"format": "[]model.ExtractConfig",
"items": {
"$ref": "#/components/schemas/dataengine.common.report.model.ExtractConfig",
"description": ""
},
"type": "array"
}
},
"type": "object"
},
"dataengine.controller.report.deleteFieldReq": {
"properties": {
"id": {
"format": "int64",
"type": "integer"
}
},
"required": [
"id"
],
"type": "object"
},
"dataengine.controller.report.deleteFieldRes": {
"properties": {
"success": {
"format": "bool",
"type": "boolean"
},
"message": {
"format": "string",
"type": "string"
}
},
"type": "object"
},
"dataengine.controller.report.getFieldReq": {
"properties": {
"id": {
"format": "int64",
"type": "integer"
}
},
"required": [
"id"
],
"type": "object"
},
"dataengine.controller.report.getFieldRes": {
"properties": {
"data": {
"$ref": "#/components/schemas/dataengine.common.report.model.FieldConfig",
"description": ""
}
},
"type": "object"
},
"dataengine.common.report.model.FieldConfig": {
"properties": {
"id": {
"format": "int64",
"type": "integer"
},
"tenantId": {
"format": "uint64",
"type": "integer"
},
"creator": {
"format": "string",
"type": "string"
},
"createdAt": {
"format": "*gtime.Time",
"type": "string"
},
"updater": {
"format": "string",
"type": "string"
},
"updatedAt": {
"format": "*gtime.Time",
"type": "string"
},
"deletedAt": {
"format": "*gtime.Time",
"type": "string"
},
"businessCode": {
"format": "string",
"type": "string"
},
"reportCode": {
"format": "string",
"type": "string"
},
"fieldCode": {
"format": "string",
"type": "string"
},
"fieldName": {
"format": "string",
"type": "string"
},
"fieldType": {
"format": "string",
"type": "string"
},
"dataType": {
"format": "string",
"type": "string"
},
"fieldRole": {
"format": "string",
"type": "string"
},
"isAggregatable": {
"format": "bool",
"type": "boolean"
},
"isFilterable": {
"format": "bool",
"type": "boolean"
},
"isQueryable": {
"format": "bool",
"type": "boolean"
},
"isSortable": {
"format": "bool",
"type": "boolean"
},
"defaultAggregate": {
"format": "string",
"type": "string"
},
"validAggregates": {
"format": "[]string",
"items": {
"format": "string",
"type": "string"
},
"type": "array"
},
"filterOperators": {
"format": "[]string",
"items": {
"format": "string",
"type": "string"
},
"type": "array"
},
"expression": {
"format": "string",
"type": "string"
},
"expressionType": {
"format": "string",
"type": "string"
},
"formatPattern": {
"format": "string",
"type": "string"
},
"unit": {
"format": "string",
"type": "string"
},
"dictCode": {
"format": "string",
"type": "string"
},
"sortOrder": {
"format": "int",
"type": "integer"
},
"groupName": {
"format": "string",
"type": "string"
},
"status": {
"format": "string",
"type": "string"
}
},
"type": "object",
"example": {
"id": 1,
"businessCode": "KUAISHOU",
"reportCode": "shop_daily",
"fieldCode": "order_amount",
"fieldName": "订单金额",
"fieldType": "FLOAT",
"fieldRole": "INDICATOR",
"defaultAggregate": "SUM"
}
},
"dataengine.controller.report.saveFieldReq": {
"properties": {
"id": {
"format": "*int64",
"type": "integer"
},
"businessCode": {
"description": "业务编码",
"format": "string",
"type": "string"
},
"reportCode": {
"description": "报表编码",
"format": "string",
"type": "string"
},
"fieldCode": {
"description": "字段编码",
"format": "string",
"type": "string"
},
"fieldName": {
"description": "字段名称",
"format": "string",
"type": "string"
},
"fieldType": {
"description": "字段类型 STRING/INT/FLOAT/DATE/DATETIME/JSONB",
"format": "string",
"type": "string"
},
"dataType": {
"default": "STRING",
"description": "数据存储类型",
"format": "string",
"type": "string"
},
"fieldRole": {
"description": "字段角色 DIMENSION/INDICATOR/FILTER/FILTER_ONLY",
"format": "string",
"type": "string"
},
"isAggregatable": {
"description": "是否可聚合",
"format": "bool",
"type": "boolean"
},
"isFilterable": {
"default": true,
"description": "是否可筛选",
"format": "bool",
"type": "boolean"
},
"isQueryable": {
"default": true,
"description": "是否可查询",
"format": "bool",
"type": "boolean"
},
"isSortable": {
"default": true,
"description": "是否可排序",
"format": "bool",
"type": "boolean"
},
"defaultAggregate": {
"description": "默认聚合方式",
"format": "string",
"type": "string"
},
"validAggregates": {
"description": "可选聚合列表",
"format": "[]string",
"items": {
"format": "string",
"type": "string"
},
"type": "array"
},
"filterOperators": {
"description": "可选操作符列表",
"format": "[]string",
"items": {
"format": "string",
"type": "string"
},
"type": "array"
},
"expression": {
"description": "表达式(衍生字段)",
"format": "string",
"type": "string"
},
"expressionType": {
"description": "表达式类型 DIRECT/CALCULATED",
"format": "string",
"type": "string"
},
"formatPattern": {
"description": "格式化模板",
"format": "string",
"type": "string"
},
"unit": {
"description": "单位",
"format": "string",
"type": "string"
},
"dictCode": {
"description": "字典编码",
"format": "string",
"type": "string"
},
"sortOrder": {
"description": "排序",
"format": "int",
"type": "integer"
},
"groupName": {
"description": "分组名称",
"format": "string",
"type": "string"
},
"status": {
"default": "ACTIVE",
"description": "状态",
"format": "string",
"type": "string"
}
},
"required": [
"businessCode",
"reportCode",
"fieldCode",
"fieldName",
"fieldType",
"fieldRole"
],
"type": "object",
"example": {
"id": null,
"businessCode": "KUAISHOU",
"reportCode": "shop_daily",
"fieldCode": "order_amount",
"fieldName": "订单金额",
"fieldType": "FLOAT",
"dataType": "FLOAT",
"fieldRole": "INDICATOR",
"isAggregatable": true,
"isFilterable": true,
"isQueryable": true,
"isSortable": true,
"defaultAggregate": "SUM",
"validAggregates": [
"SUM",
"COUNT",
"AVG",
"MAX",
"MIN"
],
"filterOperators": [
"=",
"!=",
">",
"<",
">=",
"<="
],
"expression": "",
"expressionType": "DIRECT",
"formatPattern": "#,##0.00",
"unit": "分",
"dictCode": "",
"sortOrder": 1,
"groupName": "交易指标",
"status": "ACTIVE"
}
},
"dataengine.controller.report.saveFieldRes": {
"properties": {
"success": {
"format": "bool",
"type": "boolean"
},
"id": {
"format": "int64",
"type": "integer"
},
"message": {
"format": "string",
"type": "string"
}
},
"type": "object"
},
"dataengine.controller.report.getReportFieldsReq": {
"properties": {
"businessCode": {
"format": "string",
"type": "string"
},
"reportCode": {
"format": "string",
"type": "string"
}
},
"required": [
"businessCode",
"reportCode"
],
"type": "object"
},
"dataengine.common.report.model.GetReportFieldsResp": {
"properties": {
"businessCode": {
"description": "业务编码",
"format": "string",
"type": "string"
},
"reportCode": {
"description": "报表编码",
"format": "string",
"type": "string"
},
"dimensions": {
"description": "维度字段列表",
"format": "[]model.FieldConfig",
"items": {
"$ref": "#/components/schemas/dataengine.common.report.model.FieldConfig",
"description": ""
},
"type": "array"
},
"indicators": {
"description": "指标字段列表",
"format": "[]model.FieldConfig",
"items": {
"$ref": "#/components/schemas/dataengine.common.report.model.FieldConfig",
"description": ""
},
"type": "array"
},
"filters": {
"description": "筛选字段列表",
"format": "[]model.FieldConfig",
"items": {
"$ref": "#/components/schemas/dataengine.common.report.model.FieldConfig",
"description": ""
},
"type": "array"
}
},
"type": "object"
},
"dataengine.controller.report.initTablesReq": {
"properties": {},
"type": "object"
},
"dataengine.controller.report.initTablesRes": {
"properties": {
"success": {
"format": "bool",
"type": "boolean"
},
"message": {
"format": "string",
"type": "string"
}
},
"type": "object"
},
"dataengine.controller.report.queryReportReq": {
"properties": {
"businessCode": {
"description": "业务编码",
"format": "string",
"type": "string"
},
"reportCode": {
"description": "报表编码",
"format": "string",
"type": "string"
},
"dimensions": {
"description": "统计维度列表,如 shop_id/anchor_id/date",
"format": "[]string",
"items": {
"format": "string",
"type": "string"
},
"type": "array"
},
"indicators": {
"description": "统计指标列表(含聚合方式)",
"format": "[]model.IndicatorSelect",
"items": {
"$ref": "#/components/schemas/dataengine.common.report.model.IndicatorSelect",
"description": ""
},
"type": "array"
},
"filters": {
"description": "筛选条件列表",
"format": "[]model.FilterCondition",
"items": {
"$ref": "#/components/schemas/dataengine.common.report.model.FilterCondition",
"description": ""
},
"type": "array"
},
"timeRange": {
"$ref": "#/components/schemas/dataengine.common.report.model.TimeRange",
"description": "时间范围"
},
"timeGroup": {
"description": "时间分组: day/week/month/quarter",
"format": "string",
"type": "string"
},
"orderBy": {
"description": "排序条件",
"format": "[]model.OrderCondition",
"items": {
"$ref": "#/components/schemas/dataengine.common.report.model.OrderCondition",
"description": ""
},
"type": "array"
},
"page": {
"default": 1,
"description": "页码",
"format": "int",
"type": "integer"
},
"pageSize": {
"default": 20,
"description": "每页条数",
"format": "int",
"type": "integer"
}
},
"required": [
"businessCode",
"reportCode"
],
"type": "object",
"example": {
"businessCode": "KUAISHOU",
"reportCode": "shop_daily",
"dimensions": [
"shop_id",
"stat_date"
],
"indicators": [
{
"fieldCode": "order_amount",
"aggregate": "SUM",
"alias": "总订单金额"
},
{
"fieldCode": "order_count",
"aggregate": "COUNT",
"alias": "订单数"
}
],
"filters": [
{
"fieldCode": "shop_id",
"operator": "=",
"value": "KS001"
}
],
"timeRange": {
"startDate": "2026-06-01",
"endDate": "2026-06-17"
},
"timeGroup": "day",
"orderBy": [
{
"fieldCode": "order_amount",
"direction": "DESC"
}
],
"page": 1,
"pageSize": 20
}
},
"dataengine.common.report.model.IndicatorSelect": {
"properties": {
"fieldCode": {
"description": "字段编码",
"format": "string",
"type": "string"
},
"aggregate": {
"description": "聚合方式: SUM/COUNT/AVG/MAX/MIN",
"format": "string",
"type": "string"
},
"alias": {
"description": "别名",
"format": "string",
"type": "string"
}
},
"type": "object",
"example": {
"fieldCode": "order_amount",
"aggregate": "SUM"
}
},
"dataengine.common.report.model.FilterCondition": {
"properties": {
"fieldCode": {
"description": "字段编码",
"format": "string",
"type": "string"
},
"operator": {
"description": "操作符: =/!=/>/</>=/<=/IN/LIKE/BETWEEN",
"format": "string",
"type": "string"
},
"value": {
"$ref": "#/components/schemas/interface",
"description": ""
},
"value2": {
"$ref": "#/components/schemas/interface",
"description": ""
}
},
"type": "object",
"example": {
"fieldCode": "shop_id",
"operator": "=",
"value": "KS001"
}
},
"dataengine.common.report.model.TimeRange": {
"properties": {
"startDate": {
"description": "开始日期 yyyy-MM-dd",
"format": "string",
"type": "string"
},
"endDate": {
"description": "结束日期 yyyy-MM-dd",
"format": "string",
"type": "string"
}
},
"type": "object",
"example": {
"startDate": "2026-06-01",
"endDate": "2026-06-17"
}
},
"dataengine.common.report.model.OrderCondition": {
"properties": {
"fieldCode": {
"description": "字段编码",
"format": "string",
"type": "string"
},
"direction": {
"description": "排序方向: ASC/DESC",
"format": "string",
"type": "string"
}
},
"type": "object",
"example": {
"fieldCode": "order_amount",
"direction": "DESC"
}
},
"dataengine.common.report.model.UserSelectQueryResp": {
"properties": {
"list": {
"description": "数据列表",
"format": "[]map[string]interface {}",
"items": {
"additionalProperties": {
"$ref": "#/components/schemas/interface",
"description": ""
},
"format": "map[string]interface {}",
"type": "object"
},
"type": "array"
},
"total": {
"description": "总数",
"format": "int64",
"type": "integer"
},
"page": {
"description": "当前页",
"format": "int",
"type": "integer"
},
"pageSize": {
"description": "每页条数",
"format": "int",
"type": "integer"
},
"totalPages": {
"description": "总页数",
"format": "int",
"type": "integer"
},
"sql": {
"description": "执行的SQL(调试用)",
"format": "string",
"type": "string"
},
"execTimeMs": {
"description": "执行耗时(毫秒)",
"format": "int64",
"type": "integer"
}
},
"type": "object"
},
"dataengine.controller.report.deleteReportReq": {
"properties": {
"id": {
"format": "int64",
"type": "integer"
}
},
"required": [
"id"
],
"type": "object"
},
"dataengine.controller.report.deleteReportRes": {
"properties": {
"success": {
"format": "bool",
"type": "boolean"
},
"message": {
"format": "string",
"type": "string"
}
},
"type": "object"
},
"dataengine.controller.report.getReportReq": {
"properties": {
"id": {
"format": "int64",
"type": "integer"
}
},
"required": [
"id"
],
"type": "object"
},
"dataengine.controller.report.getReportRes": {
"properties": {
"data": {
"$ref": "#/components/schemas/dataengine.common.report.model.ReportConfig",
"description": ""
}
},
"type": "object"
},
"dataengine.common.report.model.ReportConfig": {
"properties": {
"id": {
"format": "int64",
"type": "integer"
},
"tenantId": {
"format": "uint64",
"type": "integer"
},
"creator": {
"format": "string",
"type": "string"
},
"createdAt": {
"format": "*gtime.Time",
"type": "string"
},
"updater": {
"format": "string",
"type": "string"
},
"updatedAt": {
"format": "*gtime.Time",
"type": "string"
},
"deletedAt": {
"format": "*gtime.Time",
"type": "string"
},
"businessCode": {
"format": "string",
"type": "string"
},
"reportCode": {
"format": "string",
"type": "string"
},
"reportName": {
"format": "string",
"type": "string"
},
"description": {
"format": "string",
"type": "string"
},
"status": {
"format": "string",
"type": "string"
},
"statTableName": {
"format": "string",
"type": "string"
},
"statTableComment": {
"format": "string",
"type": "string"
},
"dateField": {
"format": "string",
"type": "string"
},
"primaryKeys": {
"format": "[]string",
"items": {
"format": "string",
"type": "string"
},
"type": "array"
},
"conflictKeys": {
"format": "[]string",
"items": {
"format": "string",
"type": "string"
},
"type": "array"
},
"config": {
"additionalProperties": {
"$ref": "#/components/schemas/interface",
"description": ""
},
"format": "map[string]interface {}",
"type": "object"
},
"extractConfigIds": {
"description": "抽取配置ID列表,逗号分隔",
"format": "string",
"type": "string"
}
},
"type": "object",
"example": {
"id": 1,
"businessCode": "KUAISHOU",
"reportCode": "shop_daily",
"reportName": "店铺日报",
"statTableName": "stat_kuaishou_shop_daily",
"dateField": "stat_date",
"extractConfigIds": "1,2"
}
},
"dataengine.controller.report.saveReportReq": {
"properties": {
"id": {
"format": "*int64",
"type": "integer"
},
"businessCode": {
"description": "业务编码",
"format": "string",
"type": "string"
},
"reportCode": {
"description": "报表编码",
"format": "string",
"type": "string"
},
"reportName": {
"description": "报表名称",
"format": "string",
"type": "string"
},
"description": {
"description": "描述",
"format": "string",
"type": "string"
},
"status": {
"default": "ACTIVE",
"description": "状态",
"format": "string",
"type": "string"
},
"statTableName": {
"description": "统计宽表名",
"format": "string",
"type": "string"
},
"statTableComment": {
"description": "统计宽表注释",
"format": "string",
"type": "string"
},
"dateField": {
"default": "stat_date",
"description": "日期字段",
"format": "string",
"type": "string"
},
"primaryKeys": {
"description": "主键字段",
"format": "[]string",
"items": {
"format": "string",
"type": "string"
},
"type": "array"
},
"conflictKeys": {
"description": "冲突键(唯一索引)",
"format": "[]string",
"items": {
"format": "string",
"type": "string"
},
"type": "array"
},
"config": {
"additionalProperties": {
"$ref": "#/components/schemas/interface",
"description": ""
},
"description": "扩展配置",
"format": "map[string]interface {}",
"type": "object"
}
},
"required": [
"businessCode",
"reportCode",
"reportName",
"statTableName"
],
"type": "object",
"example": {
"id": null,
"businessCode": "KUAISHOU",
"reportCode": "shop_daily",
"reportName": "店铺日报",
"description": "快手电商店铺每日统计报表",
"status": "ACTIVE",
"statTableName": "stat_kuaishou_shop_daily",
"statTableComment": "快手电商-店铺日报",
"dateField": "stat_date",
"primaryKeys": [
"shop_id",
"stat_date"
],
"conflictKeys": [
"shop_id",
"stat_date"
],
"config": {
"owner": "data-team",
"sourceSystem": "kuaishou"
}
}
},
"dataengine.controller.report.saveReportRes": {
"properties": {
"success": {
"format": "bool",
"type": "boolean"
},
"id": {
"format": "int64",
"type": "integer"
},
"message": {
"format": "string",
"type": "string"
}
},
"type": "object"
},
"dataengine.controller.report.saveReportWithFieldsReq": {
"properties": {
"id": {
"format": "*int64",
"type": "integer"
},
"businessCode": {
"description": "业务编码",
"format": "string",
"type": "string"
},
"reportCode": {
"description": "报表编码",
"format": "string",
"type": "string"
},
"reportName": {
"description": "报表名称",
"format": "string",
"type": "string"
},
"description": {
"description": "描述",
"format": "string",
"type": "string"
},
"status": {
"default": "ACTIVE",
"description": "状态",
"format": "string",
"type": "string"
},
"statTableName": {
"description": "统计宽表名",
"format": "string",
"type": "string"
},
"statTableComment": {
"description": "统计宽表注释",
"format": "string",
"type": "string"
},
"dateField": {
"default": "stat_date",
"description": "日期字段",
"format": "string",
"type": "string"
},
"primaryKeys": {
"description": "主键字段",
"format": "[]string",
"items": {
"format": "string",
"type": "string"
},
"type": "array"
},
"conflictKeys": {
"description": "冲突键(唯一索引)",
"format": "[]string",
"items": {
"format": "string",
"type": "string"
},
"type": "array"
},
"config": {
"additionalProperties": {
"$ref": "#/components/schemas/interface",
"description": ""
},
"description": "扩展配置",
"format": "map[string]interface {}",
"type": "object"
},
"fields": {
"description": "字段配置列表(全量替换,不在列表中的字段将被删除)",
"format": "[]model.SaveFieldReq",
"items": {
"$ref": "#/components/schemas/dataengine.controller.report.saveFieldReq",
"description": ""
},
"type": "array"
}
},
"required": [
"businessCode",
"reportCode",
"reportName",
"statTableName"
],
"type": "object",
"example": {
"id": null,
"businessCode": "KUAISHOU",
"reportCode": "shop_daily",
"reportName": "店铺日报",
"description": "快手电商店铺每日统计报表",
"status": "ACTIVE",
"statTableName": "stat_kuaishou_shop_daily",
"statTableComment": "快手电商-店铺日报",
"dateField": "stat_date",
"primaryKeys": ["shop_id", "stat_date"],
"conflictKeys": ["shop_id", "stat_date"],
"fields": [
{
"fieldCode": "shop_id",
"fieldName": "店铺ID",
"fieldType": "STRING",
"fieldRole": "DIMENSION",
"isFilterable": true,
"isQueryable": true,
"sortOrder": 1,
"status": "ACTIVE"
},
{
"fieldCode": "order_amount",
"fieldName": "订单金额",
"fieldType": "FLOAT",
"fieldRole": "INDICATOR",
"isAggregatable": true,
"defaultAggregate": "SUM",
"validAggregates": ["SUM", "COUNT", "AVG"],
"sortOrder": 2,
"status": "ACTIVE"
}
]
}
},
"dataengine.controller.report.saveReportWithFieldsRes": {
"properties": {
"success": {
"format": "bool",
"type": "boolean"
},
"id": {
"format": "int64",
"type": "integer"
},
"message": {
"format": "string",
"type": "string"
}
},
"type": "object"
},
"dataengine.controller.report.listReportsReq": {
"properties": {
"businessCode": {
"format": "string",
"type": "string"
}
},
"required": [
"businessCode"
],
"type": "object"
},
"dataengine.controller.report.listReportsRes": {
"properties": {
"list": {
"format": "[]model.ReportConfig",
"items": {
"$ref": "#/components/schemas/dataengine.common.report.model.ReportConfig",
"description": ""
},
"type": "array"
}
},
"type": "object"
},
"dataengine.controller.sync.QueryPlatformConfigReq": {
"description": "查看平台和接口配置",
"properties": {
"platformCode": {
"description": "平台编码",
"format": "string",
"type": "string"
}
},
"required": [
"platformCode"
],
"type": "object"
},
"dataengine.controller.sync.QueryPlatformConfigRes": {
"properties": {
"platformName": {
"format": "string",
"type": "string"
},
"platformCode": {
"format": "string",
"type": "string"
},
"apiBaseUrl": {
"format": "string",
"type": "string"
},
"authType": {
"format": "string",
"type": "string"
},
"hasToken": {
"format": "bool",
"type": "boolean"
},
"interfaceCount": {
"format": "int",
"type": "integer"
},
"interfaces": {
"format": "EmbeddedStructDefinition",
"items": {
"properties": {
"code": {
"format": "string",
"type": "string"
},
"name": {
"format": "string",
"type": "string"
},
"url": {
"format": "string",
"type": "string"
},
"hasTableDef": {
"format": "bool",
"type": "boolean"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"dataengine.controller.sync.TriggerSyncReq": {
"description": "根据平台编码和接口编码触发数据同步",
"properties": {
"platformCode": {
"description": "平台编码",
"format": "string",
"type": "string"
},
"interfaceCode": {
"description": "接口编码",
"format": "string",
"type": "string"
},
"fullSync": {
"description": "是否全量同步,true=全量 false=增量",
"format": "bool",
"type": "boolean"
}
},
"required": [
"platformCode",
"interfaceCode"
],
"type": "object"
},
"dataengine.controller.sync.TriggerSyncRes": {
"properties": {
"success": {
"format": "bool",
"type": "boolean"
},
"tableName": {
"format": "string",
"type": "string"
},
"totalRows": {
"format": "int",
"type": "integer"
},
"insertedRows": {
"format": "int",
"type": "integer"
},
"duration": {
"format": "string",
"type": "string"
}
},
"type": "object"
}
}
},
"info": {
"title": "",
"version": ""
},
"paths": {
"/api/interface/controller/createApiInterface": {
"post": {
"description": "创建新的数据接口",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.model.dto.dict.CreateApiInterfaceReq"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.model.dto.dict.CreateApiInterfaceRes"
}
}
},
"description": ""
}
},
"summary": "创建接口",
"tags": [
"接口管理"
]
}
},
"/api/interface/controller/deleteApiInterface": {
"delete": {
"description": "删除接口",
"parameters": [
{
"description": "接口ID",
"in": "query",
"name": "id",
"required": true,
"schema": {
"format": "int64",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/gitea.redpowerfuture.com.red-future.common.beans.ResponseEmpty"
}
}
},
"description": ""
}
},
"summary": "删除接口",
"tags": [
"接口管理"
]
}
},
"/api/interface/controller/getApiInterface": {
"get": {
"description": "获取接口详情",
"parameters": [
{
"description": "接口ID",
"in": "query",
"name": "id",
"required": true,
"schema": {
"format": "int64",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.model.dto.dict.GetApiInterfaceRes"
}
}
},
"description": ""
}
},
"summary": "获取接口详情",
"tags": [
"接口管理"
]
}
},
"/api/interface/controller/listApiInterfaces": {
"get": {
"description": "获取接口列表",
"parameters": [
{
"description": "平台ID",
"in": "query",
"name": "platformId",
"required": true,
"schema": {
"format": "int64",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.model.dto.dict.ListApiInterfaceRes"
}
}
},
"description": ""
}
},
"summary": "获取接口列表",
"tags": [
"接口管理"
]
}
},
"/api/interface/controller/updateApiInterface": {
"post": {
"description": "更新接口配置",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.model.dto.dict.UpdateApiInterfaceReq"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/gitea.redpowerfuture.com.red-future.common.beans.ResponseEmpty"
}
}
},
"description": ""
}
},
"summary": "更新接口",
"tags": [
"接口管理"
]
}
},
"/api/interface/controller/updateApiInterfaceStatus": {
"post": {
"description": "更新接口状态",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.model.dto.dict.UpdateApiInterfaceStatusReq"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/gitea.redpowerfuture.com.red-future.common.beans.ResponseEmpty"
}
}
},
"description": ""
}
},
"summary": "更新接口状态",
"tags": [
"接口管理"
]
}
},
"/datasource/platform/controller/createDatasourcePlatform": {
"post": {
"description": "创建新的数据源平台配置",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.model.dto.dict.CreateDatasourcePlatformReq"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.model.dto.dict.CreateDatasourcePlatformRes"
}
}
},
"description": ""
}
},
"summary": "创建数据源平台",
"tags": [
"数据源平台"
]
}
},
"/datasource/platform/controller/deleteDatasourcePlatform": {
"delete": {
"description": "删除数据源平台",
"parameters": [
{
"description": "平台ID",
"in": "query",
"name": "id",
"required": true,
"schema": {
"format": "int64",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/gitea.redpowerfuture.com.red-future.common.beans.ResponseEmpty"
}
}
},
"description": ""
}
},
"summary": "删除数据源平台",
"tags": [
"数据源平台"
]
}
},
"/datasource/platform/controller/getDatasourcePlatform": {
"get": {
"description": "获取数据源平台详情",
"parameters": [
{
"description": "平台ID",
"in": "query",
"name": "id",
"required": true,
"schema": {
"format": "int64",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.model.dto.dict.GetDatasourcePlatformRes"
}
}
},
"description": ""
}
},
"summary": "获取数据源平台详情",
"tags": [
"数据源平台"
]
}
},
"/datasource/platform/controller/getPlatformByCode": {
"get": {
"description": "根据编码获取平台信息",
"parameters": [
{
"description": "平台编码",
"in": "query",
"name": "code",
"required": true,
"schema": {
"format": "string",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.model.dto.dict.GetPlatformByCodeRes"
}
}
},
"description": ""
}
},
"summary": "根据编码获取平台信息",
"tags": [
"数据源平台"
]
}
},
"/datasource/platform/controller/getPlatformStatistics": {
"get": {
"description": "获取平台统计信息(接口数、同步状态等)",
"parameters": [
{
"description": "平台ID",
"in": "query",
"name": "id",
"required": true,
"schema": {
"format": "int64",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.model.dto.dict.GetPlatformStatisticsRes"
}
}
},
"description": ""
}
},
"summary": "获取平台统计信息",
"tags": [
"数据源平台"
]
}
},
"/datasource/platform/controller/listDatasourcePlatforms": {
"get": {
"description": "获取数据源平台列表",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.model.dto.dict.ListDatasourcePlatformRes"
}
}
},
"description": ""
}
},
"summary": "获取数据源平台列表",
"tags": [
"数据源平台"
]
}
},
"/datasource/platform/controller/updateDatasourcePlatform": {
"post": {
"description": "更新数据源平台配置",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.model.dto.dict.UpdateDatasourcePlatformReq"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/gitea.redpowerfuture.com.red-future.common.beans.ResponseEmpty"
}
}
},
"description": ""
}
},
"summary": "更新数据源平台",
"tags": [
"数据源平台"
]
}
},
"/datasource/platform/controller/updateDatasourcePlatformStatus": {
"post": {
"description": "更新数据源平台状态",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.model.dto.dict.UpdateDatasourcePlatformStatusReq"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/gitea.redpowerfuture.com.red-future.common.beans.ResponseEmpty"
}
}
},
"description": ""
}
},
"summary": "更新数据源平台状态",
"tags": [
"数据源平台"
]
}
},
"/public/query/controller/public/cache/clear": {
"delete": {
"description": "清除查询缓存",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.model.dto.public.TableListRes"
}
}
},
"description": ""
}
},
"summary": "清除查询缓存",
"tags": [
"公共查询"
]
}
},
"/public/query/controller/public/query": {
"post": {
"description": "执行通用 SQL 查询",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.model.dto.public.QueryReq"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.model.dto.public.QueryRes"
}
}
},
"description": ""
}
},
"summary": "执行公共查询",
"tags": [
"公共查询"
]
}
},
"/public/query/controller/public/tables": {
"get": {
"description": "获取可查询表列表",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.model.dto.public.TableListRes"
}
}
},
"description": ""
}
},
"summary": "获取表列表",
"tags": [
"公共查询"
]
}
},
"/public/query/controller/public/tables/{table}/columns": {
"get": {
"description": "获取指定表的字段列表",
"parameters": [
{
"description": "表名",
"in": "path",
"name": "table",
"required": true,
"schema": {
"format": "string",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.model.dto.public.ColumnListRes"
}
}
},
"description": ""
}
},
"summary": "获取表字段列表",
"tags": [
"公共查询"
]
}
},
"/sync/ctrl/config": {
"get": {
"description": "查看平台和接口配置",
"parameters": [
{
"description": "平台编码",
"in": "query",
"name": "platformCode",
"required": true,
"schema": {
"format": "string",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.controller.sync.QueryPlatformConfigRes"
}
}
},
"description": ""
}
},
"summary": "查询平台配置",
"tags": [
"平台同步"
]
}
},
"/sync/ctrl/trigger": {
"post": {
"description": "根据平台编码和接口编码触发数据同步",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.controller.sync.TriggerSyncReq"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.controller.sync.TriggerSyncRes"
}
}
},
"description": ""
}
},
"summary": "触发同步",
"tags": [
"平台同步"
]
}
},
"/report/businesses": {
"get": {
"description": "获取所有业务配置列表",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.controller.report.listBusinessesRes"
}
}
},
"description": ""
}
},
"summary": "业务列表",
"tags": [
"报表引擎"
]
}
},
"/report/business": {
"get": {
"description": "获取业务配置详情",
"parameters": [
{
"description": "业务ID",
"in": "query",
"name": "id",
"required": true,
"schema": {
"format": "int64",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.controller.report.getBusinessRes"
}
}
},
"description": ""
}
},
"summary": "获取业务",
"tags": [
"报表引擎"
]
},
"delete": {
"description": "删除业务配置",
"parameters": [
{
"description": "业务ID",
"in": "query",
"name": "id",
"required": true,
"schema": {
"format": "int64",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.controller.report.deleteBusinessRes"
}
}
},
"description": ""
}
},
"summary": "删除业务",
"tags": [
"报表引擎"
]
}
},
"/report/business/save": {
"post": {
"description": "新增或修改业务配置,id为空则新增,有值则更新",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.controller.report.saveBusinessReq"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.controller.report.saveBusinessRes"
}
}
},
"description": ""
}
},
"summary": "保存业务",
"tags": [
"报表引擎"
]
}
},
"/report/reports": {
"get": {
"description": "获取指定业务编码下的所有报表",
"parameters": [
{
"description": "业务编码",
"in": "query",
"name": "businessCode",
"required": true,
"schema": {
"format": "string",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.controller.report.listReportsRes"
}
}
},
"description": ""
}
},
"summary": "报表列表",
"tags": [
"报表引擎"
]
}
},
"/report/report": {
"get": {
"description": "获取报表配置详情",
"parameters": [
{
"description": "报表ID",
"in": "query",
"name": "id",
"required": true,
"schema": {
"format": "int64",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.controller.report.getReportRes"
}
}
},
"description": ""
}
},
"summary": "获取报表",
"tags": [
"报表引擎"
]
},
"delete": {
"description": "删除报表配置",
"parameters": [
{
"description": "报表ID",
"in": "query",
"name": "id",
"required": true,
"schema": {
"format": "int64",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.controller.report.deleteReportRes"
}
}
},
"description": ""
}
},
"summary": "删除报表",
"tags": [
"报表引擎"
]
}
},
"/report/report/save": {
"post": {
"description": "新增或修改报表配置,id为空则新增,有值则更新",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.controller.report.saveReportReq"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.controller.report.saveReportRes"
}
}
},
"description": ""
}
},
"summary": "保存报表",
"tags": [
"报表引擎"
]
}
},
"/report/report/saveWithFields": {
"post": {
"description": "保存报表及字段配置(全量替换),不在fields列表中的旧字段将被自动删除",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.controller.report.saveReportWithFieldsReq",
"description": ""
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.controller.report.saveReportWithFieldsRes",
"description": ""
}
}
},
"description": ""
}
},
"summary": "保存报表及字段配置(全量替换)",
"tags": [
"报表引擎"
]
}
},
"/report/fields": {
"get": {
"description": "获取指定报表的所有可用字段,按角色(维度/指标/筛选)分组",
"parameters": [
{
"description": "业务编码",
"in": "query",
"name": "businessCode",
"required": true,
"schema": {
"format": "string",
"type": "string"
}
},
{
"description": "报表编码",
"in": "query",
"name": "reportCode",
"required": true,
"schema": {
"format": "string",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.common.report.model.GetReportFieldsResp"
}
}
},
"description": ""
}
},
"summary": "报表字段列表(按角色分组)",
"tags": [
"报表引擎"
]
}
},
"/report/field": {
"get": {
"description": "获取字段配置详情",
"parameters": [
{
"description": "字段ID",
"in": "query",
"name": "id",
"required": true,
"schema": {
"format": "int64",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.controller.report.getFieldRes"
}
}
},
"description": ""
}
},
"summary": "获取字段",
"tags": [
"报表引擎"
]
},
"delete": {
"description": "删除字段配置",
"parameters": [
{
"description": "字段ID",
"in": "query",
"name": "id",
"required": true,
"schema": {
"format": "int64",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.controller.report.deleteFieldRes"
}
}
},
"description": ""
}
},
"summary": "删除字段",
"tags": [
"报表引擎"
]
}
},
"/report/field/save": {
"post": {
"description": "新增或修改字段配置,id为空则新增,有值则更新",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.controller.report.saveFieldReq"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.controller.report.saveFieldRes"
}
}
},
"description": ""
}
},
"summary": "保存字段",
"tags": [
"报表引擎"
]
}
},
"/report/extractConfigs": {
"get": {
"description": "获取指定报表的所有抽取配置",
"parameters": [
{
"description": "业务编码",
"in": "query",
"name": "businessCode",
"required": true,
"schema": {
"format": "string",
"type": "string"
}
},
{
"description": "报表编码",
"in": "query",
"name": "reportCode",
"required": true,
"schema": {
"format": "string",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.controller.report.getExtractConfigsRes"
}
}
},
"description": ""
}
},
"summary": "抽取配置列表",
"tags": [
"报表引擎"
]
}
},
"/report/extractConfig": {
"get": {
"description": "获取抽取配置详情",
"parameters": [
{
"description": "抽取配置ID",
"in": "query",
"name": "id",
"required": true,
"schema": {
"format": "int64",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.controller.report.getExtractConfigRes"
}
}
},
"description": ""
}
},
"summary": "获取抽取配置",
"tags": [
"报表引擎"
]
},
"delete": {
"description": "删除抽取配置",
"parameters": [
{
"description": "抽取配置ID",
"in": "query",
"name": "id",
"required": true,
"schema": {
"format": "int64",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.controller.report.deleteExtractConfigRes"
}
}
},
"description": ""
}
},
"summary": "删除抽取配置",
"tags": [
"报表引擎"
]
}
},
"/report/extractConfig/save": {
"post": {
"description": "新增或修改抽取配置,id为空则新增,有值则更新",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.controller.report.saveExtractConfigReq"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.controller.report.saveExtractConfigRes"
}
}
},
"description": ""
}
},
"summary": "保存抽取配置",
"tags": [
"报表引擎"
]
}
},
"/report/extract": {
"post": {
"description": "执行按天数据抽取,将源表数据抽取到统计宽表",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.controller.report.extractDataReq"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.common.report.model.ExtractDailyDataResp"
}
}
},
"description": ""
}
},
"summary": "执行按天数据抽取",
"tags": [
"报表引擎"
]
}
},
"/report/backfill": {
"post": {
"description": "批量回填指定日期范围内的数据",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.controller.report.backfillReq"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.common.report.model.BackfillResp"
}
}
},
"description": ""
}
},
"summary": "批量回填数据",
"tags": [
"报表引擎"
]
}
},
"/report/autoCreateTable": {
"post": {
"description": "根据报表字段配置自动创建/更新统计宽表",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.controller.report.autoCreateTableReq"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.common.report.model.AutoCreateStatTableResp"
}
}
},
"description": ""
}
},
"summary": "自动创建统计宽表",
"tags": [
"报表引擎"
]
}
},
"/report/query": {
"post": {
"description": "用户选择维度、指标、筛选条件、时间范围后查询数据",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.controller.report.queryReportReq"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.common.report.model.UserSelectQueryResp"
}
}
},
"description": ""
}
},
"summary": "用户选择查询",
"tags": [
"报表引擎"
]
}
},
"/report/initTables": {
"post": {
"description": "初始化报表引擎所需的系统表(如业务表、报表表、字段表、抽取配置表等)",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataengine.controller.report.initTablesRes"
}
}
},
"description": ""
}
},
"summary": "初始化系统表",
"tags": [
"报表引擎"
]
}
}
}
}