初始化
This commit is contained in:
49
docs/projects/xk-hy-forward-go/modules/forward.md
Normal file
49
docs/projects/xk-hy-forward-go/modules/forward.md
Normal file
@@ -0,0 +1,49 @@
|
||||
# 监管数据转发模块
|
||||
|
||||
## 监管业务数据
|
||||
|
||||
| 方法 | 路径 | 说明 |
|
||||
|------|------|------|
|
||||
| POST | `/province/supervise/data` | 转发加密的监管业务 JSON 数据至政务云 |
|
||||
|
||||
**目标**: `SUPERVISE_TARGET_URL` (端口 28212)
|
||||
|
||||
## 文件上传
|
||||
|
||||
| 方法 | 路径 | 说明 |
|
||||
|------|------|------|
|
||||
| POST | `/mng/file/auth/upload` | 转发处方 PDF 多部分上传至政务云 |
|
||||
|
||||
**目标**: `FILE_TARGET_URL` (端口 28211)
|
||||
|
||||
## 转发流程
|
||||
|
||||
```mermaid
|
||||
sequenceDiagram
|
||||
participant TRANSIT as xk-hy-transit-go
|
||||
participant FORWARD as xk-hy-forward-go
|
||||
participant GOV as 浙江省政务云
|
||||
|
||||
TRANSIT->>FORWARD: POST /province/supervise/data
|
||||
FORWARD->>FORWARD: 验证 IP 白名单
|
||||
FORWARD->>FORWARD: 过滤请求头
|
||||
FORWARD->>GOV: 转发请求
|
||||
GOV-->>FORWARD: 返回响应
|
||||
FORWARD-->>TRANSIT: 返回结果
|
||||
```
|
||||
|
||||
## 安全措施
|
||||
|
||||
| 措施 | 说明 |
|
||||
|------|------|
|
||||
| IP 白名单 | `ALLOW_IPS` 配置允许访问的 IP |
|
||||
| 共享密钥 | `FORWARD_SHARED_SECRET` 验证调用方 |
|
||||
| 请求头过滤 | 只转发白名单中的请求头 |
|
||||
| 内网部署 | 部署在内网服务器,外部无法直接访问 |
|
||||
|
||||
## Echo 模式
|
||||
|
||||
当 `ENABLE_FORWARD=false` 时,服务进入 Echo 模式:
|
||||
- 不实际转发请求
|
||||
- 返回请求的详细信息(用于调试)
|
||||
- 适合开发和测试环境
|
||||
30
docs/projects/xk-hy-forward-go/modules/health.md
Normal file
30
docs/projects/xk-hy-forward-go/modules/health.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# 健康检查模块
|
||||
|
||||
## 接口
|
||||
|
||||
| 方法 | 路径 | 说明 |
|
||||
|------|------|------|
|
||||
| GET | `/health` | 服务健康状态检查 |
|
||||
| GET | `/t` | 政务云连通性测试页面 |
|
||||
|
||||
## 健康检查
|
||||
|
||||
- **路径**: `GET /health`
|
||||
- **说明**: 服务健康状态检查
|
||||
- **返回**: 200 OK
|
||||
|
||||
## 测试页面
|
||||
|
||||
- **路径**: `GET /t`
|
||||
- **说明**: 政务云连通性测试页面
|
||||
- **用途**: 验证服务能否正常转发至政务云
|
||||
|
||||
## 日志系统
|
||||
|
||||
### API 日志
|
||||
- 记录每个请求的方法、路径、状态码、耗时
|
||||
- 格式化输出,便于排查问题
|
||||
|
||||
### 应用日志
|
||||
- 记录服务启动、配置加载、错误信息
|
||||
- 输出到控制台和日志文件
|
||||
32
docs/projects/xk-hy-forward-go/modules/index.md
Normal file
32
docs/projects/xk-hy-forward-go/modules/index.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# xk-hy-forward-go 功能模块
|
||||
|
||||
## 模块清单
|
||||
|
||||
| 模块 | 说明 | 页面 |
|
||||
|------|------|------|
|
||||
| 监管数据转发 | 监管业务数据、文件上传转发 | [监管数据转发](./forward.md) |
|
||||
| 健康检查 | 服务健康状态检查 | [健康检查](./health.md) |
|
||||
|
||||
## 架构角色
|
||||
|
||||
```mermaid
|
||||
graph LR
|
||||
subgraph 外部网络
|
||||
TRANSIT[xk-hy-transit-go<br/>外部网络]
|
||||
end
|
||||
|
||||
subgraph 内部网络
|
||||
API[xk-api<br/>监管数据打包]
|
||||
FORWARD[xk-hy-forward-go<br/>透明转发]
|
||||
end
|
||||
|
||||
subgraph 政务云
|
||||
GOV[浙江省政务云<br/>59.202.52.129]
|
||||
end
|
||||
|
||||
API -->|加密数据| TRANSIT
|
||||
TRANSIT -->|转发| FORWARD
|
||||
FORWARD -->|透传| GOV
|
||||
GOV -->|结果| FORWARD
|
||||
FORWARD -->|回调| API
|
||||
```
|
||||
Reference in New Issue
Block a user