开发文档
| 版本号 | 修改 | 修改时间 | 备注 |
|---|---|---|---|
| v1.0.0 | 王小琱 | 2024.12.20 | 初次修订 |
1. 项目简介
- 服务名称：
exchange-world-check-bridge-backend - 服务描述：本项目为交易所、金融等业务提供与 World-Check 桥接的合规风控能力，支持案件创建、查询、更新等功能，便于对接外部风控系统。
- 所属模块：合规风控服务组件。
- 负责人：王小琱（wang746277441@gmail.com）
2. 功能描述
- 新建合规风控案件（NewCases）
- 查询案件状态与报告（GetCases）
- 更新案件信息（UpdateCases）
- 支持个人与组织多类型风控数据结构
- 提供 gRPC 接口，便于系统集成
3. 系统架构
3.1 主要技术栈
- 编程语言：[Go / Protocol Buffers v3]
- 服务框架：[Go Micro / GORM]
- 数据库：[MySQL]
- API接口：[gRPC]
- 监控：[Prometheus]
- 容器编排：[Docker]
备注：具体依赖版本详见go.mod文件。
3.2 架构图
3.3 架构概括
业务层（Business Layer）
- 负责业务逻辑，调用合规风控服务。
合规风控服务层（Compliance Service Layer）
- 提供案件创建、查询、更新等风控能力，桥接 World-Check 外部服务。
3.4 业务流程
3.4.1 新建案件流程
3.4.2 查询案件流程
3.4.3 更新案件流程
4. 依赖组件
| 组件 | 版本 | 说明 |
|---|---|---|
| MySQL | 8.x | 关系型数据库 |
| World-Check | - | 外部合规风控服务 |
5. 接口设计
见接口文档
使用
make doc可以重新生成接口文档。
6. 数据库设计
7. 项目部署
见部署文档
8. 错误码定义
| 错误码 | 错误信息 | 说明 |
|---|---|---|
| ErrCallWorldCheck | 请求失败 | 调用 World-Check 失败 |
| ErrSystem | 内部错误 | 内部服务调用失败 |
9. FAQ
1. World-Check 账号和 License 如何获取？
需前往 World-Check 官方渠道注册并获取。
2. 查询返回空数据？
检查请求参数是否正确； 检查 World-Check 服务配置和网络连通性。
3. 如何扩展案件字段或风控类型？
可在 proto 文件中扩展 message 结构，并同步更新数据库表结构。
4. 如何添加/修改数据库表结构？
修改 entity 目录下的结构体定义，并执行自动迁移或手动变更数据库。
5. 如何监控服务运行状态？
通过 Prometheus 采集 metrics，推荐配合 Grafana 可视化。
10. 参考资料
11. 致谢
感谢 World-Check 提供的合规风控服务。