{ "generatedAt": "2026-05-14 14:43:29", "generatedAtLocal": "2026-05-14 14:43:29", "source": "remote", "filter": { "platform": { "value": "web", "label": "网页端" }, "project": { "value": "all", "label": "全部" } }, "module": { "name": "打印模块", "key": "print", "folder": "print", "interfaceCount": 12 }, "changes": { "fromPreviousSnapshot": { "moduleAdded": false, "moduleRenamed": false, "interfaceChanges": { "addedMethods": [], "deletedMethods": [], "paramsUpdatedMethods": [ "print.add", "print.del", "print.getComputerPrinter", "print.getItem", "print.getList", "print.savePrinters", "print.updateItem" ], "responseUpdatedMethods": [ "print.add", "print.del", "print.getComputer", "print.getComputerPrinter", "print.getItem", "print.getList", "print.savePrinters", "print.updateItem" ] } } }, "interfaces": [ { "method": "print.send", "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": "computerId", "type": "string", "required": true, "description": "打印电脑 ID" }, { "name": "count", "type": "number", "required": false, "description": "打印份数,可选" }, { "name": "data", "type": "object", "required": true, "description": "打印业务数据对象,字段由模板和 type 决定" }, { "name": "printer", "type": "string", "required": true, "description": "打印机名称" }, { "name": "template", "type": "object", "required": false, "description": "打印模板对象;仅 type=customize 时必填且应包含 page_width、page_height、template_content,type=express 可不传" }, { "name": "timestamp", "type": "string", "required": false, "description": "业务时间戳,可选" }, { "name": "type", "type": "string", "required": true, "description": "打印类型;当前实现支持 customize、express" } ], "response": [ { "name": "flag", "type": "string", "required": false, "description": "全局调用结果标识,成功时为 success,失败时为 failure" }, { "name": "code", "type": "number", "required": false, "description": "业务状态码;成功时为 200,失败时通常为 1001 或 504" }, { "name": "message", "type": "string", "required": false, "description": "返回信息" }, { "name": "printId", "type": "number", "required": false, "description": "打印记录 ID;任务入库成功后返回,失败时若已生成记录也会返回" } ] }, { "method": "print.getPrintResult", "title": "print.getPrintResult 接口", "description": "print.getPrintResult 接口", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "printId", "type": "string", "required": true, "description": "printId 参数" } ], "response": [] }, { "method": "print.getPrintRecordItem", "title": "print.getPrintRecordItem 接口", "description": "print.getPrintRecordItem 接口", "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 参数" } ], "response": [] }, { "method": "print.getList", "title": "查询当前仓库下的打印台列表,支持分页与 where 条件筛选(支持字段:id、name、computer_id、custom_barcode)。", "description": "查询当前仓库下的打印台列表,支持分页与 where 条件筛选(支持字段:id、name、computer_id、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": "page", "type": "number", "required": false, "description": "页码,默认 1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量,默认 20" }, { "name": "where", "type": "object", "required": false, "description": "筛选条件对象;支持字段:id(等值)、name、computer_id、custom_barcode;推荐使用 { operator, value, type } 标准结构" } ], "response": [ { "name": "data", "type": "object", "required": true, "description": "返回数据对象,包含 list 与 pagination" } ] }, { "method": "print.getItem", "title": "查询单个打印台详情,返回打印台对象(raw 行记录,含 subject_config)", "description": "查询单个打印台详情,返回打印台对象(raw 行记录,含 subject_config)", "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,必填" } ], "response": [ { "name": "data", "type": "object", "required": true, "description": "打印台原始记录(PrintStation raw),字段示例" } ] }, { "method": "print.add", "title": "新增打印台:关联打印电脑并可保存 subject_config(会由模型 normalizeSubjectConfig 校验)。", "description": "新增打印台:关联打印电脑并可保存 subject_config(会由模型 normalizeSubjectConfig 校验)。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "computer_id", "type": "number", "required": true, "description": "关联的打印电脑 ID(必填)" }, { "name": "name", "type": "string", "required": true, "description": "打印台名称(必填)" }, { "name": "custom_barcode", "type": "string", "required": false, "description": "自定义条码" }, { "name": "default_printer_name", "type": "string", "required": false, "description": "默认打印机名称" }, { "name": "subject_config", "type": "object", "required": false, "description": "打印台的主题/业务配置(可选,若存在将调用模型 normalizeSubjectConfig 进行校验)" } ], "response": [ { "name": "data", "type": "object", "required": true, "description": "新建的打印台对象(raw)" } ] }, { "method": "print.hasName", "title": "print.hasName 接口", "description": "print.hasName 接口", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "name", "type": "string", "required": true, "description": "name 参数" }, { "name": "id", "type": "number", "required": false, "description": "id 参数" } ], "response": [] }, { "method": "print.updateItem", "title": "更新打印台信息:支持更新 name、computer_id、custom_barcode、default_printer_name 以及 subject_config(会走 normalizeSubjectConfig)。", "description": "更新打印台信息:支持更新 name、computer_id、custom_barcode、default_printer_name 以及 subject_config(会走 normalizeSubjectConfig)。", "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(必填)" }, { "name": "computer_id", "type": "number", "required": false, "description": "要更新的打印电脑 ID" }, { "name": "custom_barcode", "type": "string", "required": false, "description": "自定义条码" }, { "name": "name", "type": "string", "required": false, "description": "打印台名称" }, { "name": "default_printer_name", "type": "string", "required": false, "description": "默认打印机名称" }, { "name": "subject_config", "type": "object", "required": false, "description": "subject_config(可选),传入将替换/规范化配置" } ], "response": [ { "name": "data", "type": "object", "required": false, "description": "更新结果,通常返回 null" } ] }, { "method": "print.del", "title": "批量删除(软删除)打印台:将指定 ids 的记录标记为 deleted=1。", "description": "批量删除(软删除)打印台:将指定 ids 的记录标记为 deleted=1。", "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", "required": true, "description": "要删除的打印台 ID 数组,必须为非空数组(示例: [1,2,3])" } ], "response": [ { "name": "data", "type": "object", "required": false, "description": "返回空数据结构,表示操作成功" } ] }, { "method": "print.getComputer", "title": "查询当前仓库下状态为 1 的打印电脑列表(raw 列表)。", "description": "查询当前仓库下状态为 1 的打印电脑列表(raw 列表)。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [ { "name": "data", "type": "array", "required": true, "description": "打印电脑数组,每项为打印电脑的原始记录" } ] }, { "method": "print.getComputerPrinter", "title": "获取指定打印电脑的打印机列表(从 redis: printer:{id}:printerList 读取并返回 data 数组,通常为打印机名称数组或对象数组)。", "description": "获取指定打印电脑的打印机列表(从 redis: printer:{id}:printerList 读取并返回 data 数组,通常为打印机名称数组或对象数组)。", "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,必填" } ], "response": [ { "name": "data", "type": "array", "required": true, "description": "打印机数组,通常为字符串名称数组或打印机对象数组(取决于 redis 存储格式)" } ] }, { "method": "print.savePrinters", "title": "保存打印台的默认打印机与快递-打印机绑定;会使用 print_station_id 标识目标打印台,并批量 upsert PrintStationExpress 记录。", "description": "保存打印台的默认打印机与快递-打印机绑定;会使用 print_station_id 标识目标打印台,并批量 upsert PrintStationExpress 记录。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "defaultPrinter", "type": "string", "required": true, "description": "默认打印机名称(必填)" }, { "name": "express", "type": "array", "required": true, "description": "快递绑定数组,必填。每项至少包含 express_id(number)和 name(打印机/快递名称,string)" }, { "name": "print_station_id", "type": "number", "required": true, "description": "目标打印台 ID,必填" } ], "response": [ { "name": "data", "type": "object", "required": false, "description": "返回空数据结构表示成功(实现中返回 { data: null, code: 0 })" } ] } ] }