WMS_MAIN/methods/changes/openapi.json
2026-04-27 16:09:26 +08:00

64 lines
3.5 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.

[
{
"version": "2026.04.26-openapi-01",
"date": "2026-04-26",
"summary": "新增 openapi 入口文档骨架(/openapi),包含请求体解析、app_key 与签名校验规则",
"methods": [
"openapi.index"
],
"notes": [
"新增 methods/openapi.json:记录 /openapi 入口的文档骨架与校验约定(JSON body 解析、统一错误格式、app_key 校验、签名规则)。",
"核心校验规则:1) body 使用 JSON 解析,优先 rawBody;2) 错误对外格式使用 toFailure(flag/code/message/data/timestamp);3) app_key 仅当数据库记录的 interface_type_id=2 且 is_enabled=1 时视为有效;4) 签名按 query 字段字母序排序(排除 sign/signature)+ selfAppSecret + bodySign(md5(stableSerialize(body))),对拼接字符串取 md5。"
],
"type": "added"
}
,
{
"version": "2026.04.26-openapi-02",
"date": "2026-04-26",
"summary": "说明:/openapi 入口不校验请求头,补充签名别名与 app_key 有效性说明",
"methods": [
"openapi.index"
],
"notes": [
"修正:明确 /openapi 入口不对请求头进行强制校验(与 qimen 一致),headers 字段仅作为参考。",
"确认:body JSON 解析(rawBody 优先)与错误消息保持为 'json数据为空' / 'json数据解析错误';app_key 校验仅当 wms_api_app.interface_type_id=2 且 is_enabled=1 时有效。",
"补充:签名字段别名说明(sign/signature)与 app_key 别名(app_key/appkey/self_app_key);签名算法与实现参见 app/lib/api_sign.js。"
],
"type": "modified"
},
{
"version": "2026.04.26-openapi-03",
"date": "2026-04-26",
"summary": "新增 openapi 方法 index.ping(基础模块,心跳接口)",
"methods": [
"index.ping"
],
"notes": [
"新增 openapi 可用性检测接口 index.ping,返回与系统成功结构一致(包含 code/message/data)。"
],
"type": "added"
}
,
{
"version": "2026.04.26-openapi-04",
"date": "2026-04-26",
"summary": "规范化 /openapi 文档:独立链路、移除请求头校验、返回风格改为 code/message/data、明确签名与 app_key 校验、指向 openapiMethods 分发。",
"methods": [
"openapi.index",
"index.ping"
],
"notes": [
"本次变更:",
"1) 明确 /openapi 为独立链路,不复用 system/qimen 的请求头校验;",
"2) 移除 platform/project 等请求头的强校验说明;",
"3) 返回结构与 system 风格对齐(使用 code/message/data,移除额外 flag 字段);",
"4) 保持 body 为 JSON(rawBody 优先),并明确错误文案为 'json数据为空' / 'json数据解析错误';",
"5) 明确 app_key 仅当 wms_api_app.interface_type_id=2 且 is_enabled=1 时视为有效;",
"6) 明确签名算法:query 按字母序排序 + self_app_secret + bodySign(md5(stableSerialize(body))),支持别名 sign/signature 与 app_key/appkey/self_app_key;",
"7) 说明 method 分发走 openapiMethods 专用目录,示例方法 index.ping(基础模块)。"
],
"type": "modified"
}
]