feat: 规范化PocketBase数据库文档与原生API访问
- 将数据库文档拆分为按collection命名的标准文件,统一格式 - 补充tbl_company、tbl_system_dict等表的原生访问规则 - 新增users_tag、document_create等字段 - 优化用户资料更新接口,支持非必填字段 - 添加公司原生API测试脚本 - 归档本次变更至OpenSpec
This commit is contained in:
18
docs/api.md
18
docs/api.md
@@ -133,6 +133,7 @@
|
||||
"users_type": "注册用户",
|
||||
"users_name": "张三",
|
||||
"users_phone": "13800138000",
|
||||
"users_tag": "核心客户",
|
||||
"users_phone_masked": "138****8000",
|
||||
"users_picture": "ATT-1743123456789-abc123",
|
||||
"users_picture_url": "https://bai-api.blv-oa.com/pb/api/files/pbc_xxx/recordId/avatar.png",
|
||||
@@ -163,6 +164,8 @@
|
||||
{
|
||||
"users_name": "张三",
|
||||
"users_phone_code": "2b7d9f2e3c4a5b6d7e8f",
|
||||
"users_phone": "13800138000",
|
||||
"users_tag": "核心客户",
|
||||
"users_picture": "ATT-1743123456789-abc123",
|
||||
"users_id_pic_a": "ATT-1743123456789-id-a",
|
||||
"users_id_pic_b": "ATT-1743123456789-id-b",
|
||||
@@ -174,9 +177,11 @@
|
||||
|
||||
| 参数名 | 类型 | 必填 | 说明 |
|
||||
|---|---|---|---|
|
||||
| `users_name` | string | 是 | 用户姓名 |
|
||||
| `users_phone_code` | string | 是 | 微信手机号获取凭证 code,后端将据此换取真实手机号 |
|
||||
| `users_picture` | string | 是 | 用户头像附件的 `attachments_id` |
|
||||
| `users_name` | string | 否 | 用户姓名;非空时才更新 |
|
||||
| `users_phone_code` | string | 否 | 微信手机号获取凭证 code;若提供,服务端优先据此换取真实手机号 |
|
||||
| `users_phone` | string | 否 | 直接写入的手机号;仅在未提供 `users_phone_code` 时生效 |
|
||||
| `users_tag` | string | 否 | 用户标签;非空时才更新 |
|
||||
| `users_picture` | string | 否 | 用户头像附件的 `attachments_id`;非空时才更新 |
|
||||
| `users_id_pic_a` | string | 否 | 证件正面附件的 `attachments_id` |
|
||||
| `users_id_pic_b` | string | 否 | 证件反面附件的 `attachments_id` |
|
||||
| `users_title_picture` | string | 否 | 资质附件的 `attachments_id` |
|
||||
@@ -186,8 +191,10 @@
|
||||
- 从 `Authorization` 对应的 PocketBase auth record 读取当前用户 `openid`
|
||||
- 校验 `Authorization`
|
||||
- 不再从 body 读取 `users_wx_code`
|
||||
- 使用 `users_phone_code` 调微信官方接口换取真实手机号
|
||||
- 将真实手机号写入数据库字段 `users_phone`
|
||||
- 所有字段均允许不传或传空
|
||||
- 若传入 `users_phone_code`,优先调用微信接口换取真实手机号并写入 `users_phone`
|
||||
- 若未传 `users_phone_code` 但传入 `users_phone`,则直接写入数据库字段 `users_phone`
|
||||
- 未传或传空的字段不会清空数据库中的已有值;只有非空字段才会更新
|
||||
- `users_picture`、`users_id_pic_a`、`users_id_pic_b`、`users_title_picture` 均按 `attachments_id` 存储,服务端查询用户信息时会自动补充对应文件流链接
|
||||
- 若用户首次从“三项资料均为空”变为“三项资料均完整”,则将 `users_type` 从 `游客` 升级为 `注册用户`
|
||||
- 返回更新后的完整用户信息
|
||||
@@ -205,6 +212,7 @@
|
||||
"users_type": "注册用户",
|
||||
"users_name": "张三",
|
||||
"users_phone": "13800138000",
|
||||
"users_tag": "核心客户",
|
||||
"users_phone_masked": "138****8000",
|
||||
"users_picture": "ATT-1743123456789-abc123",
|
||||
"users_picture_url": "https://bai-api.blv-oa.com/pb/api/files/pbc_xxx/recordId/avatar.png",
|
||||
|
||||
Reference in New Issue
Block a user