2026-05-13 18:14:13 +08:00

508 lines
12 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"generatedAt": "2026-05-13 09:46:41",
"generatedAtLocal": "2026-05-13 09:46:41",
"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.send"
],
"responseUpdatedMethods": [
"print.send"
]
}
}
},
"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": true,
"description": "打印模板对象;type=customize 时通常需要包含 page_width、page_height、template_content"
},
{
"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": "print.getList 接口",
"description": "print.getList 接口",
"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": "page 参数"
},
{
"name": "pageSize",
"type": "number",
"required": false,
"description": "pageSize 参数"
},
{
"name": "where",
"type": "object",
"required": false,
"description": "统一 where 条件对象;推荐使用 { operator, value, type } 标准结构,历史简写会在 main 中自动标准化;当前支持 id、name、computer_id、custom_barcode。示例:where.name={operator:like,value:热敏}; where.computer_id={operator:eq,value:PC-01}。"
}
],
"response": []
},
{
"method": "print.getItem",
"title": "print.getItem 接口",
"description": "print.getItem 接口",
"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.add",
"title": "print.add 接口",
"description": "print.add 接口",
"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": "computer_id 参数"
},
{
"name": "name",
"type": "string",
"required": true,
"description": "name 参数"
},
{
"name": "custom_barcode",
"type": "string",
"required": false,
"description": "custom_barcode 参数"
},
{
"name": "default_printer_name",
"type": "string",
"required": false,
"description": "default_printer_name 参数"
}
],
"response": []
},
{
"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": "print.updateItem 接口",
"description": "print.updateItem 接口",
"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": "computer_id 参数"
},
{
"name": "custom_barcode",
"type": "string",
"required": false,
"description": "custom_barcode 参数"
},
{
"name": "name",
"type": "string",
"required": false,
"description": "name 参数"
}
],
"response": []
},
{
"method": "print.del",
"title": "print.del 接口",
"description": "print.del 接口",
"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": false,
"description": "ids 参数"
}
],
"response": []
},
{
"method": "print.getComputer",
"title": "print.getComputer 接口",
"description": "print.getComputer 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"method": "print.getComputerPrinter",
"title": "print.getComputerPrinter 接口",
"description": "print.getComputerPrinter 接口",
"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.savePrinters",
"title": "print.savePrinters 接口",
"description": "print.savePrinters 接口",
"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": "defaultPrinter 参数"
},
{
"name": "express",
"type": "array",
"required": false,
"description": "express 参数"
},
{
"name": "print_station_id",
"type": "number",
"required": false,
"description": "print_station_id 参数"
}
],
"response": []
}
]
}