- 回调 method 由 snake_case 事件名改为 模块.动作:entryorder.confirm / entryorder.match / deliveryorder.confirm / stockout.confirm / deliveryorder.cancel(原 order.cancel 与入站方法同名,改名避免 callback_url 误指向 /openapi 时被路由到取消单据接口)。
- 时间戳统一为秒级(String(Math.floor(Date.now()/1000))),与 /openapi 入站 ±600 秒时效校验及回调调试页一致。
- 报文体由 { event, data, metadata } 改为奇门同层级 { request: {...} }(移除 metadata,事件标识只靠 query 的 method);入库类回调与奇门侧共用同一份报文组装。
- deliveryorder.confirm 改为逐单发送(仅同步成功的订单);stockout.confirm 直接复用 buildStockoutConfirmDataInternal 结果。
- 修复 entryorder.match 死代码:绑定成功且本次新建绑定时回传,重复触发不重复通知,回传失败不影响绑定。
- 调试页 /docs/api/openapi/callback-test 按真实报文预填;新增出站回调文档页 /docs/api/openapi_callback 及入口链接。
- script/update-api-doc.cjs 支持 spec.newDoc 新建文档与 docMeta.description(附单测)。
- 文档:methods/openapi_callback.json、AI_METHOD_ROUTING.md 5.6 节、docs/openapi-callback-events.md、docs/api-doc-update-workflow.md 等。
50 lines
1.6 KiB
JSON
50 lines
1.6 KiB
JSON
{
|
||
"docName": "example",
|
||
"newDoc": {
|
||
"module": "example",
|
||
"description": "示例文档(由 docs/api-doc-update-spec.example.json 复制而来,正式使用时请按需修改 docName/newDoc/group/methods/change)",
|
||
"http": { "path": "/example", "method": "POST" },
|
||
"headers": [
|
||
{ "name": "Content-Type", "type": "string", "required": true, "description": "application/json" }
|
||
]
|
||
},
|
||
"docMeta": {
|
||
"version": "0.1.0",
|
||
"updatedAt": "2026-09-12"
|
||
},
|
||
"group": {
|
||
"groupName": "示例分组",
|
||
"module": "example"
|
||
},
|
||
"methods": [
|
||
{
|
||
"method": "example.ping",
|
||
"description": "示例方法:演示固定 spec 的最小结构。",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": false,
|
||
"headers": [],
|
||
"params": [
|
||
{ "name": "name", "type": "string", "required": true, "source": "query", "description": "示例入参" }
|
||
],
|
||
"response": [
|
||
{ "name": "ok", "type": "boolean", "required": true, "description": "是否成功" }
|
||
],
|
||
"errors": [
|
||
{ "code": 400, "message": "参数错误" }
|
||
],
|
||
"notes": [
|
||
"params 允许 source(query/body);headers/response 不写 source;response 项必须含 boolean 的 required"
|
||
]
|
||
}
|
||
],
|
||
"deleteMethods": [],
|
||
"change": {
|
||
"version": "2026.09.12-example-init",
|
||
"date": "2026-09-12",
|
||
"type": "added",
|
||
"summary": "示例变更记录。",
|
||
"methods": [ "example.ping" ],
|
||
"notes": [ "正式使用时请替换为真实的 version/summary/methods/notes,并确保 version 不重复" ]
|
||
}
|
||
}
|