3.2 KiB
3.2 KiB
AI 克隆系统交付说明
1. 项目简介
本项目为“AI 克隆系统”,提供以下能力:
- 声音复刻(音色创建/管理)
- 对话/通话类功能(依赖后端接口)
- 照片复活/图片生成视频(后端任务 + 视频合成托管)
- 用户体系(注册/登录/短信验证码/微信小程序登录)
- 支付与计费(服务定价、下单、订单状态、按次/免费次数/补偿次数)
- 管理端(Vue3 + Element Plus)用于运营/管理
- 小程序/uni-app 前端(
frontend-ai/)用于移动端交互
2. 交付物清单
-
后端服务(Spring Boot)
- 目录:
ai-clone/ - 运行产物:
ai-clone/target/voice-cloning-1.0.0.jar
- 目录:
-
管理端前端(静态站点)
- 目录:
admin/ - 构建产物:
admin/dist/
- 目录:
-
小程序/uni-app 前端
- 目录:
frontend-ai/ - API 配置说明:
frontend-ai/config/README.md
- 目录:
3. 运行环境与依赖
- 后端:
- Java:JDK 8(后端
ai-clone/pom.xml约束为 1.8) - Maven:3.6+
- MySQL:8.x(或兼容版本)
- Java:JDK 8(后端
- 管理端:
- Node.js:建议 18+
- 小程序/uni-app:
- HBuilderX(或 uni-app 对应构建链路)
4. 服务与端口约定
- 后端 API:默认 20002(以
ai-clone/src/main/resources/application.properties的server.port为准) - 管理端前端:常见部署为静态站点端口 20002 或通过 Nginx 80/443 反代(由运维确定)
5. 核心接口(对接方常用)
说明:以下为“路由前缀级别”的对接索引,具体参数以代码/接口调试为准。
- 语音/音色
- 前缀:
/api/voice - 示例:创建音色、音色列表、删除音色
- 前缀:
- 照片复活/视频
- 前缀:
/api/revival(以PhotoRevivalController实际映射为准)
- 前缀:
- 用户体系
- 前缀:
/api/user - 示例:登录、微信登录、注册、找回密码等
- 前缀:
- 管理端账号
- 前缀:
/api/admin - 示例:管理员登录/注册、管理员列表等
- 前缀:
- 支付与计费
- 前缀:
/api/pay - 示例:服务价格列表、创建订单、查询订单状态、使用次数预览等
- 前缀:
6. 配置项(交付时需要替换)
重要:交付环境禁止使用仓库中硬编码的 Key/密码。部署时请按下列项替换为客户方正式配置。
- 第三方 API:
- 通义/百炼 DashScope:
dashscope.api.key - 图片生成视频/第三方:
grsai.api.key(如启用)
- 通义/百炼 DashScope:
- 数据库:
spring.datasource.urlspring.datasource.usernamespring.datasource.password
- 微信小程序登录:
wechat.mini.appidwechat.mini.secret
- 短信服务(如启用):
aliyun.sms.access-key-idaliyun.sms.access-key-secretaliyun.sms.sign-namealiyun.sms.template-code
- 文件托管/静态资源:
filehosting.local.pathfilehosting.url.prefixspring.web.resources.static-locations
7. 验收方式(建议)
- 后端健康检查:访问
GET /api/voice/health返回status=ok - 管理端:可正常打开首页,且能成功调用后端 API(以实际部署域名/端口为准)
- 小程序/uni-app:可正常登录、拉取列表、提交生成任务(以实际业务页面为准)