API 协议约定

Forge 后端接口的稳定响应是 RespInfo。字段以源码为准。

统一响应格式

com.mdframe.forge.starter.core.domain.RespInfo：

{
  "code": 200,
  "message": "操作成功",
  "data": {},
  "timestamp": 1710000000000
}

字段	类型	说明
code	Integer	HTTP/业务状态。成功常用 200
message	String	提示文案。不是 msg
data	Object	业务数据，无数据时可空
timestamp	Long	毫秒时间戳

return RespInfo.success(data);
return RespInfo.error("用户名已存在");

errorKey / traceId / help 还没进运行时，见 错误响应协议。

请求体必须用 DTO

Controller 接 @RequestBody 必须用明确 DTO/VO，禁止 Map 再 params.get("xxx")。

@PostMapping("/approve")
public RespInfo<Void> approve(@RequestBody FlowTaskApproveDTO dto) {
    flowTaskService.approve(dto.getTaskId(), dto.getComment());
    return RespInfo.success();
}

允许的例外：低代码动态记录体、流程 variables、键名不固定的扩展属性。固定字段必须进 DTO。

分页请求/响应形状见 分页协议。加解密见 加解密协议。

相关文档

• 错误响应协议
• 分页协议