罗展丰
Published on 2026-06-12 / 25 Visits
0
0

初始化对接文档

基础信息

  • 基础路径:/sys/v1/init
  • 协议:HTTP/HTTPS
  • 内容类型:application/json

接口列表

1. 获取初始化任务列表

请求

GET /sys/v1/init/list

无请求参数。

响应

{
    "code": 200,
    "msg": "success",
    "data": [
        {
            "name": "集团多工厂下发",
            "code": "csDispatch"
        },
        {
            "name": "集团多工厂归集",
            "code": "csUpload"
        },
        {
            "name": "预警",
            "code": "warn"
        },
        {
            "name": "字典元数据初始化",
            "code": "dict"
        },
        {
            "name": "编码规则",
            "code": "encoder"
        },
        {
            "name": "定时任务",
            "code": "schedule"
        }
    ]
}
字段 类型 说明
name String 初始化任务名称
code String 初始化任务编码,用于按编码执行

2. 执行全部初始化

请求

POST /sys/v1/init/start-all

无请求参数。

响应

{
    "code": 200,
    "msg": "success",
    "data": {
        "success": [
            "集团多工厂下发",
            "集团多工厂归集",
            "预警",
            "字典元数据初始化",
            "编码规则",
            "定时任务"
        ],
        "fail": []
    }
}
字段 类型 说明
success List<String> 执行成功的任务名称列表
fail List<String> 执行失败的任务列表,格式为 "任务名称: 错误信息"

说明

  • 逐个执行所有已注册的 Initializer
  • 单个失败不影响其他任务继续执行
  • 返回时包含成功和失败的汇总

3. 按编码执行单个初始化

请求

POST /sys/v1/init/start/{code}
参数 位置 类型 必填 说明
code path String 是 初始化任务编码

可用编码值

编码 对应任务
csDispatch 集团多工厂下发
csUpload 集团多工厂归集
warn 预警
dict 字典元数据初始化
encoder 编码规则
schedule 定时任务

响应 - 成功

{
    "code": 200,
    "msg": "成功执行",
    "data": null
}

响应 - 编码不存在

{
    "code": 500,
    "msg": "未找到code为 xxx 的初始化任务",
    "data": null
}

错误码

HTTP 状态码 业务码 说明
200 200 成功
500 500 服务端异常(编码不存在、初始化执行异常等)

对接注意事项

  1. start-all 为全量执行,生产环境慎用,建议优先使用 start/{code} 按需执行
  2. start/{code} 执行失败时会直接返回异常,不会返回部分成功状态
  3. 所有接口均无鉴权说明(需根据项目实际鉴权配置处理)

初始化界面

image-TAvI.png

image-ZJTw.png


Comment