docs(database): 更新数据库设计规范和核心数据表结构
- 新增数据库基础规范、API映射规范、安全规范等详细设计要求- 增加读写分离、分库分表、数据生命周期管理等策略说明 - 新建核心业务表结构,包括用户表、贷款申请表、保险申请表等 - 优化索引设计,提高查询效率
This commit is contained in:
32
docs/design/api/data-platform.md
Normal file
32
docs/design/api/data-platform.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# 数据中台系统 API 文档
|
||||
|
||||
## 1. 接口概述
|
||||
|
||||
### 1.1 功能范围
|
||||
- 数据血缘追踪
|
||||
- 接口调用分析
|
||||
- 数据质量监控
|
||||
|
||||
### 1.2 基础路径
|
||||
`/api/v1/data`
|
||||
|
||||
## 2. 接口明细
|
||||
|
||||
### 2.1 数据血缘查询
|
||||
```
|
||||
GET /lineage
|
||||
```
|
||||
|
||||
| 参数 | 类型 | 必填 | 说明 |
|
||||
|-------------|--------|------|--------------------|
|
||||
| source | string | 否 | 源表名 |
|
||||
| target | string | 否 | 目标表名 |
|
||||
|
||||
### 2.2 接口审计
|
||||
```
|
||||
GET /audit-logs
|
||||
```
|
||||
|
||||
## 3. 性能指标
|
||||
- 血缘查询响应时间 < 500ms
|
||||
- 审计日志保留至少180天
|
||||
57
docs/design/api/farming.md
Normal file
57
docs/design/api/farming.md
Normal file
@@ -0,0 +1,57 @@
|
||||
# 养殖管理系统 API 文档 (v1.1.0)
|
||||
|
||||
## 1. 接口概述
|
||||
|
||||
### 1.1 功能范围
|
||||
- 牛只档案管理
|
||||
- 饲喂记录
|
||||
- 防疫管理
|
||||
- 繁殖管理
|
||||
|
||||
### 1.2 基础路径
|
||||
`/api/v1/farming`
|
||||
|
||||
## 2. 接口明细
|
||||
|
||||
### 2.1 添加牛只
|
||||
```
|
||||
POST /cattles
|
||||
```
|
||||
|
||||
| 字段 | 类型 | 必填 | 说明 |
|
||||
|--------------|--------|------|--------------------|
|
||||
| ear_tag | string | 是 | 耳标号(唯一) |
|
||||
| breed | string | 是 | 品种 |
|
||||
| birth_date | string | 是 | 出生日期(YYYY-MM-DD)|
|
||||
| gender | string | 是 | 性别(公/母) |
|
||||
| weight | number | 否 | 体重(kg) |
|
||||
|
||||
### 2.2 批量导入牛只
|
||||
```
|
||||
POST /cattles/batch
|
||||
```
|
||||
|
||||
| 字段 | 类型 | 必填 | 说明 |
|
||||
|--------------|--------|------|--------------------|
|
||||
| file | file | 是 | Excel文件 |
|
||||
|
||||
### 2.3 防疫记录
|
||||
```
|
||||
POST /vaccinations
|
||||
```
|
||||
|
||||
| 字段 | 类型 | 必填 | 说明 |
|
||||
|--------------|--------|------|--------------------|
|
||||
| cattle_id | string | 是 | 牛只ID |
|
||||
| vaccine_type | string | 是 | 疫苗类型 |
|
||||
| date | string | 是 | 接种日期(YYYY-MM-DD)|
|
||||
|
||||
## 3. 数据规范
|
||||
- 耳标号格式:省简称+6位数字(如NM000001)
|
||||
- 疫苗记录保留至少5年
|
||||
- 敏感数据需RSA加密传输
|
||||
|
||||
## 4. 权限控制
|
||||
- 添加牛只:养殖管理员
|
||||
- 批量导入:系统管理员
|
||||
- 防疫记录:兽医
|
||||
54
docs/design/api/finance.md
Normal file
54
docs/design/api/finance.md
Normal file
@@ -0,0 +1,54 @@
|
||||
# 金融业务系统 API 文档 (v1.1.0)
|
||||
|
||||
## 1. 接口概述
|
||||
|
||||
### 1.1 功能范围
|
||||
- 贷款申请
|
||||
- 保险购买
|
||||
- 理赔处理
|
||||
- 贷款审批
|
||||
|
||||
### 1.2 基础路径
|
||||
`/api/v1/finance`
|
||||
|
||||
## 2. 接口明细
|
||||
|
||||
### 2.1 贷款申请
|
||||
```
|
||||
POST /loans
|
||||
```
|
||||
|
||||
| 字段 | 类型 | 必填 | 说明 |
|
||||
|-----------------|---------|------|--------------------|
|
||||
| farmer_id | number | 是 | 牧户ID |
|
||||
| amount | number | 是 | 申请金额(元) |
|
||||
| collateral_type | string | 是 | 抵押物类型 |
|
||||
| term | number | 是 | 贷款期限(月) |
|
||||
| interest_rate | number | 是 | 年利率(%) |
|
||||
|
||||
### 2.2 贷款审批状态查询
|
||||
```
|
||||
GET /loans/:id/status
|
||||
```
|
||||
|
||||
### 2.3 保险购买
|
||||
```
|
||||
POST /insurances
|
||||
```
|
||||
|
||||
| 字段 | 类型 | 必填 | 说明 |
|
||||
|-----------------|---------|------|--------------------|
|
||||
| farmer_id | number | 是 | 牧户ID |
|
||||
| cattle_id | string | 是 | 牛只ID |
|
||||
| insurance_type | string | 是 | 保险类型 |
|
||||
| premium | number | 是 | 保费(元) |
|
||||
|
||||
## 3. 风控规则
|
||||
- 单笔贷款金额 ≤ 牧户资产总额的50%
|
||||
- 理赔申请需在灾害发生后30天内提交
|
||||
- 敏感数据需RSA加密传输
|
||||
|
||||
## 4. 权限控制
|
||||
- 贷款申请:牧户
|
||||
- 贷款审批:银行管理员
|
||||
- 保险购买:牧户
|
||||
52
docs/design/api/government.md
Normal file
52
docs/design/api/government.md
Normal file
@@ -0,0 +1,52 @@
|
||||
# 政府监管系统 API 文档 (v1.1.0)
|
||||
|
||||
## 1. 接口概述
|
||||
|
||||
### 1.1 功能范围
|
||||
- 防疫任务下发
|
||||
- 补贴发放
|
||||
- 检疫监管
|
||||
- 任务状态跟踪
|
||||
|
||||
### 1.2 基础路径
|
||||
`/api/v1/gov`
|
||||
|
||||
## 2. 接口明细
|
||||
|
||||
### 2.1 创建防疫任务
|
||||
```
|
||||
POST /quarantines
|
||||
```
|
||||
|
||||
| 字段 | 类型 | 必填 | 说明 |
|
||||
|---------------|--------|------|--------------------|
|
||||
| location | string | 是 | GPS坐标(纬度,经度)|
|
||||
| inspector_id | number | 是 | 检疫员ID |
|
||||
| deadline | string | 是 | 截止日期(YYYY-MM-DD)|
|
||||
| task_type | string | 是 | 任务类型(常规/紧急)|
|
||||
| priority | number | 否 | 优先级(1-5) |
|
||||
|
||||
### 2.2 防疫任务状态查询
|
||||
```
|
||||
GET /quarantines/:id/status
|
||||
```
|
||||
|
||||
### 2.3 检疫监管
|
||||
```
|
||||
POST /inspections
|
||||
```
|
||||
|
||||
| 字段 | 类型 | 必填 | 说明 |
|
||||
|---------------|--------|------|--------------------|
|
||||
| cattle_id | string | 是 | 牛只ID |
|
||||
| inspector_id | number | 是 | 检疫员ID |
|
||||
| result | string | 是 | 检疫结果(合格/不合格)|
|
||||
|
||||
## 3. 审计要求
|
||||
- 所有操作记录操作人IP和时间
|
||||
- 敏感数据需RSA加密传输
|
||||
|
||||
## 4. 权限控制
|
||||
- 防疫任务下发:政府管理员
|
||||
- 检疫监管:检疫员
|
||||
- 补贴发放:财务人员
|
||||
33
docs/design/api/miniprograms/farming-app.md
Normal file
33
docs/design/api/miniprograms/farming-app.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# 养殖助手小程序 API 文档
|
||||
|
||||
## 1. 接口概述
|
||||
|
||||
### 1.1 功能范围
|
||||
- 养殖记录
|
||||
- 饲喂提醒
|
||||
- 防疫上报
|
||||
|
||||
### 1.2 基础路径
|
||||
`/api/mini/farming`
|
||||
|
||||
## 2. 接口明细
|
||||
|
||||
### 2.1 添加饲喂记录
|
||||
```
|
||||
POST /feedings
|
||||
```
|
||||
|
||||
| 字段 | 类型 | 必填 | 说明 |
|
||||
|--------------|--------|------|--------------------|
|
||||
| cattle_id | number | 是 | 牛只ID |
|
||||
| feed_type | string | 是 | 饲料类型 |
|
||||
| amount | number | 是 | 投喂量(kg) |
|
||||
|
||||
### 2.2 防疫上报
|
||||
```
|
||||
POST /vaccinations
|
||||
```
|
||||
|
||||
## 3. 数据规范
|
||||
- 时间字段格式: YYYY-MM-DD HH:mm:ss
|
||||
- 数量单位统一使用kg
|
||||
33
docs/design/api/miniprograms/gov-app.md
Normal file
33
docs/design/api/miniprograms/gov-app.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# 政府监管小程序 API 文档
|
||||
|
||||
## 1. 接口概述
|
||||
|
||||
### 1.1 功能范围
|
||||
- 防疫检查
|
||||
- 补贴发放
|
||||
- 违规上报
|
||||
|
||||
### 1.2 基础路径
|
||||
`/api/mini/gov`
|
||||
|
||||
## 2. 接口明细
|
||||
|
||||
### 2.1 提交检查报告
|
||||
```
|
||||
POST /inspections
|
||||
```
|
||||
|
||||
| 字段 | 类型 | 必填 | 说明 |
|
||||
|---------------|--------|------|--------------------|
|
||||
| farm_id | number | 是 | 养殖场ID |
|
||||
| result | string | 是 | 检查结果 |
|
||||
| photos | array | 是 | 现场照片URL数组 |
|
||||
|
||||
### 2.2 查看补贴名单
|
||||
```
|
||||
GET /subsidies
|
||||
```
|
||||
|
||||
## 3. 安全要求
|
||||
- 所有接口需政府专线VPN接入
|
||||
- 照片数据需加密存储
|
||||
35
docs/design/api/miniprograms/merchant-app.md
Normal file
35
docs/design/api/miniprograms/merchant-app.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# 商户小程序 API 文档
|
||||
|
||||
## 1. 接口概述
|
||||
|
||||
### 1.1 功能范围
|
||||
- 商品管理
|
||||
- 订单处理
|
||||
- 数据统计
|
||||
|
||||
### 1.2 基础路径
|
||||
`/api/mini/merchant`
|
||||
|
||||
## 2. 接口明细
|
||||
|
||||
### 2.1 添加商品
|
||||
```
|
||||
POST /products
|
||||
```
|
||||
|
||||
| 字段 | 类型 | 必填 | 说明 |
|
||||
|--------------|--------|------|--------------------|
|
||||
| name | string | 是 | 商品名称 |
|
||||
| price | number | 是 | 价格(元) |
|
||||
| stock | number | 是 | 库存数量 |
|
||||
|
||||
### 2.2 处理订单
|
||||
```
|
||||
PUT /orders/{id}
|
||||
```
|
||||
|
||||
## 3. 错误码规范
|
||||
| 代码 | 说明 |
|
||||
|------|----------------|
|
||||
| 4001 | 库存不足 |
|
||||
| 4002 | 订单已过期 |
|
||||
34
docs/design/api/miniprograms/user-app.md
Normal file
34
docs/design/api/miniprograms/user-app.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# 用户小程序 API 文档
|
||||
|
||||
## 1. 接口概述
|
||||
|
||||
### 1.1 功能范围
|
||||
- 用户登录/注册
|
||||
- 商品浏览/购买
|
||||
- 订单查询
|
||||
- 个人中心
|
||||
|
||||
### 1.2 基础路径
|
||||
`/api/mini/user`
|
||||
|
||||
## 2. 接口明细
|
||||
|
||||
### 2.1 微信登录
|
||||
```
|
||||
POST /login
|
||||
```
|
||||
|
||||
| 字段 | 类型 | 必填 | 说明 |
|
||||
|------------|--------|------|----------------|
|
||||
| code | string | 是 | 微信登录code |
|
||||
| encryptedData | string | 是 | 加密用户数据 |
|
||||
| iv | string | 是 | 加密算法的初始向量 |
|
||||
|
||||
### 2.2 获取商品列表
|
||||
```
|
||||
GET /products
|
||||
```
|
||||
|
||||
## 3. 权限控制
|
||||
- 所有接口需携带`access_token`
|
||||
- 敏感接口需二次验证(如支付密码)
|
||||
62
docs/design/api/trade.md
Normal file
62
docs/design/api/trade.md
Normal file
@@ -0,0 +1,62 @@
|
||||
# 交易系统 API 文档 (v1.1.0)
|
||||
|
||||
## 1. 接口概述
|
||||
|
||||
### 1.1 功能范围
|
||||
- 商品发布/下架
|
||||
- 订单创建/支付
|
||||
- 物流跟踪
|
||||
- 订单状态查询
|
||||
|
||||
### 1.2 基础路径
|
||||
`/api/v1/trades`
|
||||
|
||||
## 2. 接口明细
|
||||
|
||||
### 2.1 商品发布
|
||||
```
|
||||
POST /products
|
||||
```
|
||||
|
||||
| 字段 | 类型 | 必填 | 说明 |
|
||||
|--------------|--------|------|--------------------|
|
||||
| name | string | 是 | 商品名称 |
|
||||
| price | number | 是 | 价格(元) |
|
||||
| stock | number | 是 | 库存数量 |
|
||||
| category | string | 是 | 商品分类 |
|
||||
|
||||
### 2.2 创建订单
|
||||
```
|
||||
POST /orders
|
||||
```
|
||||
|
||||
| 字段 | 类型 | 必填 | 说明 |
|
||||
|--------------|--------|------|--------------------|
|
||||
| product_id | number | 是 | 商品ID |
|
||||
| quantity | number | 是 | 购买数量 |
|
||||
| address_id | number | 是 | 收货地址ID |
|
||||
| payment_method | string | 是 | 支付方式(微信/支付宝)|
|
||||
| coupon_code | string | 否 | 优惠券码 |
|
||||
|
||||
### 2.3 物流跟踪
|
||||
```
|
||||
GET /logistics/:order_id
|
||||
```
|
||||
|
||||
## 3. 状态流转
|
||||
```mermaid
|
||||
stateDiagram
|
||||
[*] --> 待支付
|
||||
待支付 --> 已支付: 支付成功
|
||||
已支付 --> 配送中: 商家发货
|
||||
配送中 --> 已完成: 确认收货
|
||||
```
|
||||
|
||||
## 4. 安全要求
|
||||
- 支付接口需HTTPS加密
|
||||
- 敏感数据需RSA加密传输
|
||||
|
||||
## 5. 权限控制
|
||||
- 商品发布:商户
|
||||
- 订单创建:用户
|
||||
- 物流跟踪:用户/商户
|
||||
36
docs/design/api/user-center.md
Normal file
36
docs/design/api/user-center.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# 用户中心系统 API 文档
|
||||
|
||||
## 1. 接口概述
|
||||
|
||||
### 1.1 功能范围
|
||||
- 用户注册/登录/注销
|
||||
- 个人信息管理
|
||||
- 权限控制
|
||||
|
||||
### 1.2 基础路径
|
||||
`/api/v1/users`
|
||||
|
||||
## 2. 接口明细
|
||||
|
||||
### 2.1 用户注册
|
||||
```
|
||||
POST /register
|
||||
```
|
||||
|
||||
| 字段 | 类型 | 必填 | 说明 |
|
||||
|------------|--------|------|----------------|
|
||||
| username | string | 是 | 4-20位字母数字 |
|
||||
| password | string | 是 | 6-20位含大小写 |
|
||||
| phone | string | 是 | 11位手机号 |
|
||||
|
||||
### 2.2 用户登录
|
||||
```
|
||||
POST /login
|
||||
```
|
||||
|
||||
## 3. 状态码规范
|
||||
| 代码 | 说明 |
|
||||
|------|----------------|
|
||||
| 200 | 成功 |
|
||||
| 400 | 参数校验失败 |
|
||||
| 401 | 认证失败 |
|
||||
Reference in New Issue
Block a user