docs(signing): 补充真实接口接入说明

This commit is contained in:
yelan
2026-08-31 16:09:15 +08:00
parent 9c1b2f53a6
commit f4f40f0596

View File

@@ -84,7 +84,7 @@ TanStack Vue Query、PDF 预览、报表图表、自动化测试和签字板适
## 当前状态 ## 当前状态
已完成 Vite 基础初始化、路由、Pinia、原型主题 CSS、登录页、首页、签署工作台第一版 Mock 和文档库管理页面。报表、用户权限、文档权限和系统设置仍保留页面骨架登录和签署流程使用演示数据,尚未接入真实后端 已完成 Vite 基础初始化、路由、Pinia、原型主题 CSS、登录页、首页、签署工作台第一版 Mock 和文档库管理页面。报表、用户权限、文档权限和系统设置仍保留页面骨架登录接口和签署工作台的患者、就诊、模板、任务及审计查询/部分任务操作已接入 MEDISIGN 后端;其余页面仍使用 Mock 或占位实现
## 当前路由结构 ## 当前路由结构
@@ -125,8 +125,6 @@ API 模块与页面按业务域对应。工作台页面使用 `api/workbench`
- `api/management/document-permissions.ts` - `api/management/document-permissions.ts`
- `api/management/settings.ts` - `api/management/settings.ts`
API 请求和响应类型按业务域放在 `api/workbench/types.ts``api/management/types.ts`;页面展示和交互类型放在对应 View 目录的 `types.ts`;全局复用类型放在 `types/common.ts`
所有接口统一使用 `utils/request.ts` 导出的单例请求实例。登录接口已接入 MEDISIGN 后端: 所有接口统一使用 `utils/request.ts` 导出的单例请求实例。登录接口已接入 MEDISIGN 后端:
- `POST /api/v1/auth/login`:账号密码登录; - `POST /api/v1/auth/login`:账号密码登录;
@@ -134,8 +132,20 @@ API 请求和响应类型按业务域放在 `api/workbench/types.ts`、`api/mana
- `POST /api/v1/auth/logout`:注销当前会话; - `POST /api/v1/auth/logout`:注销当前会话;
- 后续请求自动携带 `X-Token` 请求头。 - 后续请求自动携带 `X-Token` 请求头。
开发环境默认使用 `/api` 作为同源接口前缀Vite 会将 `/api` 转发到 `https://ipad.shenynet.com`,因此浏览器不会直接跨域请求后端。代理配置位于 `vite.config.ts`,不改写 `/api/v1/...` 路径。修改代理配置后需要重启 Vite 开发服务。 签署工作台已接入的真实接口包括:
生产环境不会使用 Vite 的开发代理,需要在 Nginx 或其他网关中配置同样的 `/api` 反向代理。 - `GET /api/v1/patients``GET /api/v1/patients/{id}`:患者定位;
- `GET /api/v1/patients/{id}/visits``GET /api/v1/visits`:就诊关联;
- `GET /api/v1/templates/available-versions`:可发起模板版本;
- `GET /api/v1/sign-tasks``GET /api/v1/sign-tasks/{id}`:任务列表和详情;
- `POST /api/v1/sign-tasks``POST /api/v1/sign-tasks/{id}/prepare-send`:创建任务和准备投递;
- `POST /api/v1/sign-tasks/{id}/void``/resend``/reopen`:作废、短信重发和重新开启;
- `GET /api/v1/sign-tasks/{id}/events`:操作审计事件。
除登录外,当前业务 API 模块默认返回 mock 数据,设置 `VITE_USE_MOCK=false` 后切换为真实接口。使用本地开发代理时,`VITE_API_BASE_URL` 应填写 `/api`;如果改为直连后端,则需要后端配置允许当前前端源的 CORS。 API 请求和响应类型按业务域放在 `api/workbench/types.ts``api/management/types.ts`;页面展示和交互类型放在对应 View 目录的 `types.ts`;全局复用类型放在 `types/common.ts`。页面提交模型会在 API 边界转换为后端 DTO不向后端发送患者快照、文档名称或明文手机号等页面字段。
开发环境默认使用 `/api` 作为同源接口前缀Vite 会将 `/api` 转发到 `https://ipad.shenynet.com`,因此浏览器不会直接跨域请求后端。代理配置位于 `vite.config.ts`,不改写 `/api/v1/...` 路径。修改代理或环境变量后需要重启 Vite 开发服务。
生产环境不会使用 Vite 的开发代理,需要在 Nginx 或其他网关中配置同样的 `/api` 反向代理。除登录外,当前业务 API 模块默认返回 Mock 数据,设置 `VITE_USE_MOCK=false` 后切换签署工作台及其他已实现 API 的真实接口。使用本地开发代理时,`VITE_API_BASE_URL` 应填写 `/api`;如果改为直连后端,则需要后端配置允许当前前端源的 CORS。
当前尚未接入的签署能力包括手写板设备桥接、线上签署页面/签名回调、PDF 原件下载、签名原图下载和打印服务。真实接口模式下这些演示按钮会隐藏或提示待接入Mock 模式仍可用于演示完整交互。