280 lines
7.0 KiB
JSON
280 lines
7.0 KiB
JSON
{
|
||
"generatedAt": "2026-06-04 09:53:13",
|
||
"generatedAtLocal": "2026-06-04 09:53:13",
|
||
"source": "remote",
|
||
"filter": {
|
||
"platform": {
|
||
"value": "web",
|
||
"label": "网页端"
|
||
},
|
||
"project": {
|
||
"value": "all",
|
||
"label": "全部"
|
||
}
|
||
},
|
||
"module": {
|
||
"name": "包材管理模块",
|
||
"key": "setting.packageMaterial",
|
||
"folder": "setting.packagematerial",
|
||
"interfaceCount": 5
|
||
},
|
||
"changes": {
|
||
"fromPreviousSnapshot": {
|
||
"moduleAdded": false,
|
||
"moduleRenamed": false,
|
||
"interfaceChanges": {
|
||
"addedMethods": [],
|
||
"deletedMethods": [],
|
||
"paramsUpdatedMethods": [],
|
||
"responseUpdatedMethods": []
|
||
}
|
||
}
|
||
},
|
||
"interfaces": [
|
||
{
|
||
"method": "setting.packageMaterial.create",
|
||
"title": "创建包材(当前仓库范围)",
|
||
"description": "创建包材(当前仓库范围)",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "material_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "包材编码(大写且在当前仓库唯一)"
|
||
},
|
||
{
|
||
"name": "material_name",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "包材名称"
|
||
},
|
||
{
|
||
"name": "material_type",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "包材类型"
|
||
},
|
||
{
|
||
"name": "spec",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "规格"
|
||
},
|
||
{
|
||
"name": "length",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "长度"
|
||
},
|
||
{
|
||
"name": "width",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "宽度"
|
||
},
|
||
{
|
||
"name": "height",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "高度"
|
||
},
|
||
{
|
||
"name": "weight",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "重量"
|
||
},
|
||
{
|
||
"name": "cost_price",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "成本价"
|
||
},
|
||
{
|
||
"name": "status",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "状态 0/1,默认 1"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "包材 ID"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "setting.packageMaterial.update",
|
||
"title": "更新包材(按 id 更新,支持部分字段)",
|
||
"description": "更新包材(按 id 更新,支持部分字段)",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "包材 ID(也兼容 material_id/materialId)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "包材 ID"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "setting.packageMaterial.delete",
|
||
"title": "删除包材(支持 ids 数组或逗号分隔字符串,兼容 id/material_id/materialId)",
|
||
"description": "删除包材(支持 ids 数组或逗号分隔字符串,兼容 id/material_id/materialId)",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "ids",
|
||
"type": "array|number|string",
|
||
"required": true,
|
||
"description": "要删除的 ID 列表"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "deleted",
|
||
"type": "boolean",
|
||
"required": true,
|
||
"description": "是否删除成功"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "setting.packageMaterial.get",
|
||
"title": "查询包材列表,支持 where + pagination(兼容旧别名 list,建议使用 get)",
|
||
"description": "查询包材列表,支持 where + pagination(兼容旧别名 list,建议使用 get)",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "分页参数,支持 page/pageSize"
|
||
},
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "筛选条件,支持 material_code/material_name/material_type/status/quickWhere"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "page",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "当前页"
|
||
},
|
||
{
|
||
"name": "page_size",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "每页大小"
|
||
},
|
||
{
|
||
"name": "total",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "总数"
|
||
},
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "包材项数组"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "setting.packageMaterial.list",
|
||
"title": "兼容旧称 list,内部转发至 get;建议改用 setting.packageMaterial.get",
|
||
"description": "兼容旧称 list,内部转发至 get;建议改用 setting.packageMaterial.get",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
}
|
||
]
|
||
}
|