446 lines
11 KiB
JSON
446 lines
11 KiB
JSON
{
|
||
"generatedAt": "2026-05-20 16:44:18",
|
||
"generatedAtLocal": "2026-05-20 16:44:18",
|
||
"source": "remote",
|
||
"filter": {
|
||
"platform": {
|
||
"value": "web",
|
||
"label": "网页端"
|
||
},
|
||
"project": {
|
||
"value": "all",
|
||
"label": "全部"
|
||
}
|
||
},
|
||
"module": {
|
||
"name": "基础模块",
|
||
"key": "index",
|
||
"folder": "index",
|
||
"interfaceCount": 14
|
||
},
|
||
"changes": {
|
||
"fromPreviousSnapshot": {
|
||
"moduleAdded": false,
|
||
"moduleRenamed": false,
|
||
"interfaceChanges": {
|
||
"addedMethods": [],
|
||
"deletedMethods": [],
|
||
"paramsUpdatedMethods": [],
|
||
"responseUpdatedMethods": []
|
||
}
|
||
}
|
||
},
|
||
"interfaces": [
|
||
{
|
||
"method": "index.fastWhereTree",
|
||
"title": "index.fastWhereTree 接口",
|
||
"description": "index.fastWhereTree 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "type",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "type 参数"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "index.loadStores",
|
||
"title": "index.loadStores 接口",
|
||
"description": "index.loadStores 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "index.getCOSUploadConfig",
|
||
"title": "index.getCOSUploadConfig 接口",
|
||
"description": "index.getCOSUploadConfig 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "data",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "data 参数"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "index.getImages",
|
||
"title": "index.getImages 接口",
|
||
"description": "index.getImages 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "index.uploadSuccessNotify",
|
||
"title": "index.uploadSuccessNotify 接口",
|
||
"description": "index.uploadSuccessNotify 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "index.ReferenceFile",
|
||
"title": "index.ReferenceFile 接口",
|
||
"description": "index.ReferenceFile 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "index.getMessageDetail",
|
||
"title": "index.getMessageDetail 接口",
|
||
"description": "index.getMessageDetail 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "index.recognizeLicensePlate",
|
||
"title": "识别车牌号码(通过 base64 图片)",
|
||
"description": "识别车牌号码(通过 base64 图片)",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "base64",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "base64 图片,支持 data URL 前缀(data:image/...;base64,)或纯 base64 字符串"
|
||
},
|
||
{
|
||
"name": "imageBase64",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "兼容字段(同 base64)"
|
||
},
|
||
{
|
||
"name": "image_base64",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "兼容字段(同 base64)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "licensePlate",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "识别到的车牌号(对外契约,仅返回该字段)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "index.getI18nMessage",
|
||
"title": "index.getI18nMessage 接口",
|
||
"description": "index.getI18nMessage 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": false,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [],
|
||
"params": [
|
||
{
|
||
"name": "language",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "language 参数"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "index.putI18nCollect",
|
||
"title": "index.putI18nCollect 接口",
|
||
"description": "index.putI18nCollect 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": false,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [],
|
||
"params": [
|
||
{
|
||
"name": "keys",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "keys 参数"
|
||
},
|
||
{
|
||
"name": "locale",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "locale 参数"
|
||
},
|
||
{
|
||
"name": "project",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "project 参数"
|
||
},
|
||
{
|
||
"name": "source",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "source 参数"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "index.tryAutoTranslateNewKeys",
|
||
"title": "index.tryAutoTranslateNewKeys 接口",
|
||
"description": "index.tryAutoTranslateNewKeys 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "index.searchSpace",
|
||
"title": "按当前仓库上下文搜索库位(使用 ctx.user.store_id;仅在 location_space 表中按 space_code/custom_barcode 搜索)",
|
||
"description": "按当前仓库上下文搜索库位(使用 ctx.user.store_id;仅在 location_space 表中按 space_code/custom_barcode 搜索)",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "keyword",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "搜索关键字,对 space_code 和 custom_barcode 做模糊匹配(%keyword%);为空时返回当前仓库下前 50 条"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "flag",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "全局调用结果标识,成功时为 success"
|
||
},
|
||
{
|
||
"name": "code",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "业务状态码,200 表示成功"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "返回信息"
|
||
},
|
||
{
|
||
"name": "data",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "库位数组(最多 50 条),每项包含以下字段"
|
||
},
|
||
{
|
||
"name": "total",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "本次返回的记录条数(等于 data.length,≤50)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "index.listInterfaceTypes",
|
||
"title": "查询可用的接口类型列表(如奇门仓储、开放接口等)",
|
||
"description": "查询可用的接口类型列表(如奇门仓储、开放接口等)",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "index.getLocationTypeList",
|
||
"title": "查询库位类型基础列表,优先返回当前仓库下启用的库位类型,同时合并系统公共类型;结果带 300 秒缓存",
|
||
"description": "查询库位类型基础列表,优先返回当前仓库下启用的库位类型,同时合并系统公共类型;结果带 300 秒缓存",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "库位类型列表"
|
||
},
|
||
{
|
||
"name": "total",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "返回总数"
|
||
}
|
||
]
|
||
}
|
||
]
|
||
}
|