SuperAPI AI 工具集

documenso-upgrade-migration

编程与开发

查看项目

更新于 10-15 23:25

技能介绍

用途:指导 Documenso API 版本与 SDK 的升级迁移。Documenso 有两个 API 版本:v1(旧版、以文档为中心,路径 /api/v1/,仅 REST)和 v2(推荐、基于 envelope、支持多文档,路径 /api/v2/,有 TypeScript 和 Python SDK)。认证方式均为 Authorization: Bearer。

主要能力:检查当前 SDK 版本并升级;把 v1 REST 调用迁移到 v2 SDK;用特性标志逐步放量;自托管镜像升级与回滚;编写 v1/v2 结果一致性测试。

使用方式:先查看版本,例如 npm list @documenso/sdk-typescript、pip show documenso-sdk-python;升级用 npm install @documenso/sdk-typescript@latest 或 pip install --upgrade documenso-sdk-python。自托管升级先 docker pull documenso/documenso:latest,再 docker compose -f docker-compose.prod.yml up -d documenso,启动时自动执行迁移,可用 docker logs documenso --tail 20 | grep "prisma migrate" 与 /api/health 校验;回滚需切换到 previous-tag 重新启动。迁移建议在开发环境用合成文档和签名人测试生命周期、回调、访问与审计行为,再灰度发布,保留旧版本与配置以便回滚,不要用真实已签署文档做验证。

适用场景:从 v1 升到 v2、更新 SDK、在自托管或云环境做渐进迁移。

限制与注意:v1 与 v2 存在字段差异(如 id 与 documentId)、枚举大小写(v2 用 "SIGNER")、模板 API 差异,需要适配层并跑一致性测试。资料未提供具体收费、价格或性能数据。