带TJSONObject参数的Delphi REST接口测试配置及500错误解决方法

之前测试返回500的核心触发点 #

• 路由方法名拼写错误：实际定义的服务方法为UpdateCIM2，测试时URL误写为UpdatCIM2（漏写字母e），服务端无法匹配到对应方法时，会直接抛出500内部错误而非404
• 请求体格式不符合DataSnap内置序列化规则：自定义的嵌套data键的JSON结构，服务端无法完成入参映射
• 请求头缺少必要的编码声明，老版本DataSnap服务对无编码标记的JSON请求解析失败

通用基础请求配置 #

• 请求方法：POST
• 修正后的正确URL：https://wxdf0-servername.com/snap4.dll/datasnap/rest/TGeneral/UpdateCIM2
• 必带请求头：Content-Type: application/json; charset=utf-8

正确的请求Body格式 #

Delphi DataSnap REST接口对JSON入参的解析规则为：所有方法入参按定义顺序组成数组，作为请求体根节点，不需要额外嵌套自定义键名。
结合你给出的方法定义（仅1个TJSONObject类型入参PostData），分两种场景对应正确格式：

1. 如果PostData对象本身包含data字段嵌套结构，请求体写为：

[
  {
    "data": {
      "Stage": "7",
      "Step": "1"
    }
  }
]

2. 如果PostData对象直接包含Stage、Step字段，请求体写为：

[
  {
    "Stage": "7",
    "Step": "1"
  }
]

核心注意点：入参必须放在数组根节点下，不能直接把裸JSON对象作为请求体根节点发送。你之前直接把嵌套对象放在根节点的写法，服务端完全无法识别参数位置。

Delphi自带REST Debugger适配配置 #

• 填入上述修正后的URL、POST请求方法
• 在请求头配置页添加指定的Content-Type头
• 在请求Body输入区粘贴符合数组格式的JSON内容
• 无需添加额外鉴权头（服务端无身份验证要求）
• 直接发起请求即可在响应区获取返回值

快速排错步骤 #

• 若依然报500错误，可先发送测试请求体[{}]（空对象作为入参）：如果请求能正常返回，说明是你传入的JSON结构和服务端TJSONObject定义的字段不匹配；如果仍然报错，优先检查URL拼写、snap4.dll的服务权限、REST路由是否正常开启
• 部署在非Windows环境的DataSnap服务会对方法名大小写敏感，需保证URL中的方法名和服务端定义的拼写、大小写完全一致
• 不要在URL后拼接任何查询参数，所有入参必须放在POST请求体中

内容的提问来源于stack exchange，提问作者brg