From 4fa29276478c6bee9d221456de7a1fe81bf95765 Mon Sep 17 00:00:00 2001 From: Hommy Date: Tue, 18 Nov 2025 11:04:58 +0800 Subject: [PATCH] =?UTF-8?q?=E4=BC=98=E5=8C=96=E6=96=87=E6=A1=A3=E3=80=82?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/add_audios.md | 25 ++++- docs/add_captions.md | 26 ++++- docs/add_effects.md | 28 +++++- docs/add_images.md | 11 +- docs/add_videos.md | 25 ++++- docs/create_draft.md | 93 ++++++++++++----- docs/gen_video.md | 25 ++++- docs/get_draft.md | 22 +++- docs/index.md | 232 +++++++++++++++++++++++++++++-------------- docs/save_draft.md | 24 ++++- 10 files changed, 391 insertions(+), 120 deletions(-) diff --git a/docs/add_audios.md b/docs/add_audios.md index afd0f7b..2c2b380 100644 --- a/docs/add_audios.md +++ b/docs/add_audios.md @@ -1,6 +1,19 @@ # ADD_AUDIOS API 接口文档 -## 接口信息 +## 📋 目录 + +- [🔧 接口信息](#-接口信息) +- [🎯 功能描述](#-功能描述) +- [📥 请求参数](#-请求参数) +- [📤 响应格式](#-响应格式) +- [💻 使用示例](#-使用示例) +- [❌ 错误码说明](#-错误码说明) +- [⚠️ 注意事项](#️-注意事项) +- [🔄 工作流程](#-工作流程) +- [➡️ 下一步操作](#️-下一步操作) +- [🔗 相关接口](#-相关接口) + +## 🔧 接口信息 ``` POST /openapi/capcut-mate/v1/add_audios @@ -616,4 +629,12 @@ for config in [bgm_config, sequence_config, effects_config]: - [添加视频](./add_videos.md) - [添加图片](./add_images.md) - [保存草稿](./save_draft.md) -- [生成视频](./gen_video.md) \ No newline at end of file +- [生成视频](./gen_video.md) + +--- + +
+ +**📚 项目资源**: [GitHub](https://github.com/Hommy-master/capcut-mate) | [Gitee](https://gitee.com/taohongmin-gitee/capcut-mate) + +
\ No newline at end of file diff --git a/docs/add_captions.md b/docs/add_captions.md index a2cd9f6..c703b50 100644 --- a/docs/add_captions.md +++ b/docs/add_captions.md @@ -1,6 +1,18 @@ -# add_captions 接口文档 +# ADD_CAPTIONS API 接口文档 -## 接口描述 +## 📋 目录 + +- [🔧 接口描述](#-接口描述) +- [🔧 接口信息](#-接口信息) +- [📖 更多文档](#-更多文档) +- [📥 请求参数](#-请求参数) +- [📤 响应结果](#-响应结果) +- [💻 使用示例](#-使用示例) +- [❌ 错误码说明](#-错误码说明) +- [⚠️ 注意事项](#️-注意事项) +- [🔗 相关接口](#-相关接口) + +## 🔧 接口描述 向剪映草稿批量添加字幕,支持丰富的字幕样式设置,包括关键词高亮、字体样式、边框效果、对齐方式、透明度和动画效果等。 ## 接口信息 @@ -229,4 +241,12 @@ fetch(url, { 3. **循环动画**: 支持字幕的循环动画效果 4. **样式文本**: 支持富文本格式的字幕样式 5. **字体选择**: 支持自定义字体文件 -6. **边框和阴影**: 支持字幕边框和阴影效果 \ No newline at end of file +6. **边框和阴影**: 支持字幕边框和阴影效果 + +--- + +
+ +**📚 项目资源**: [GitHub](https://github.com/Hommy-master/capcut-mate) | [Gitee](https://gitee.com/taohongmin-gitee/capcut-mate) + +
\ No newline at end of file diff --git a/docs/add_effects.md b/docs/add_effects.md index 0113513..0e1c913 100644 --- a/docs/add_effects.md +++ b/docs/add_effects.md @@ -1,6 +1,19 @@ -# 添加特效接口文档 +# ADD_EFFECTS API 接口文档 -## 接口概述 +## 📋 目录 + +- [🔧 接口概述](#-接口概述) +- [📖 更多文档](#-更多文档) +- [🔧 接口信息](#-接口信息) +- [📥 请求参数](#-请求参数) +- [📤 响应格式](#-响应格式) +- [💻 使用示例](#-使用示例) +- [❌ 错误码说明](#-错误码说明) +- [📖 使用说明](#-使用说明) +- [⚠️ 注意事项](#️-注意事项) +- [🔗 相关接口](#-相关接口) + +## 🔧 接口概述 向现有剪映草稿中添加视频特效轨道和特效片段。支持批量添加多种视频特效,包括边框特效、滤镜特效、动态特效等,为视频内容增加丰富的视觉效果。 ## 更多文档 @@ -121,4 +134,13 @@ curl -X POST "https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/add_effects" - [创建草稿](./create_draft.md) - 创建新的剪映草稿 - [添加视频](./add_videos.md) - 向草稿添加视频内容 -- [保存草稿](./save_draft.md) - 保存草稿更改 \ No newline at end of file +- [保存草稿](./save_draft.md) - 保存草稿更改 + +--- + +
+ +📚 **项目资源** +[GitHub](https://github.com/Hommy-master/capcut-mate) | [Gitee](https://gitee.com/taohongmin-gitee/capcut-mate) + +
\ No newline at end of file diff --git a/docs/add_images.md b/docs/add_images.md index 6a7ed8a..03ac2e9 100644 --- a/docs/add_images.md +++ b/docs/add_images.md @@ -318,4 +318,13 @@ print(f"图片添加成功: {result['track_id']}") - [添加视频](./add_videos.md) - [添加音频](./add_audios.md) - [保存草稿](./save_draft.md) -- [生成视频](./gen_video.md) \ No newline at end of file +- [生成视频](./gen_video.md) + +--- + +
+ +📚 **项目资源** +[GitHub](https://github.com/Hommy-master/capcut-mate) | [Gitee](https://gitee.com/taohongmin-gitee/capcut-mate) + +
\ No newline at end of file diff --git a/docs/add_videos.md b/docs/add_videos.md index 6087b6e..74258f6 100644 --- a/docs/add_videos.md +++ b/docs/add_videos.md @@ -1,6 +1,19 @@ # ADD_VIDEOS API 接口文档 -## 接口信息 +## 📋 目录 + +- [🔧 接口信息](#-接口信息) +- [🎯 功能描述](#-功能描述) +- [📥 请求参数](#-请求参数) +- [📤 响应格式](#-响应格式) +- [💻 使用示例](#-使用示例) +- [❌ 错误码说明](#-错误码说明) +- [⚠️ 注意事项](#️-注意事项) +- [🔄 工作流程](#-工作流程) +- [➡️ 下一步操作](#️-下一步操作) +- [🔗 相关接口](#-相关接口) + +## 🔧 接口信息 ``` POST /openapi/capcut-mate/v1/add_videos @@ -608,4 +621,12 @@ print(f"结果: {result}") - [添加音频](./add_audios.md) - [添加图片](./add_images.md) - [保存草稿](./save_draft.md) -- [生成视频](./gen_video.md) \ No newline at end of file +- [生成视频](./gen_video.md) + +--- + +
+ +**📚 项目资源**: [GitHub](https://github.com/Hommy-master/capcut-mate) | [Gitee](https://gitee.com/taohongmin-gitee/capcut-mate) + +
\ No newline at end of file diff --git a/docs/create_draft.md b/docs/create_draft.md index b11377f..9793b60 100644 --- a/docs/create_draft.md +++ b/docs/create_draft.md @@ -1,6 +1,20 @@ # CREATE_DRAFT API 接口文档 -## 接口信息 +## 📋 目录 + +- [🔧 接口信息](#-接口信息) +- [🎯 功能描述](#-功能描述) +- [📖 更多文档](#-更多文档) +- [📥 请求参数](#-请求参数) +- [📤 响应格式](#-响应格式) +- [💻 使用示例](#-使用示例) +- [❌ 错误码说明](#-错误码说明) +- [⚠️ 注意事项](#️-注意事项) +- [🔄 工作流程](#-工作流程) +- [➡️ 下一步操作](#️-下一步操作) +- [🔗 相关接口](#-相关接口) + +## 🔧 接口信息 ``` POST /openapi/capcut-mate/v1/create_draft @@ -80,7 +94,7 @@ POST /openapi/capcut-mate/v1/create_draft } ``` -## 使用示例 +## 💻 使用示例 ### cURL 示例 @@ -116,7 +130,10 @@ curl -X POST https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/create_draft \ ### JavaScript 示例 +#### 基础使用 + ```javascript +// 创建草稿函数 const createDraft = async (width = 1920, height = 1080) => { const response = await fetch('/openapi/capcut-mate/v1/create_draft', { method: 'POST', @@ -126,23 +143,26 @@ const createDraft = async (width = 1920, height = 1080) => { return response.json(); }; -// 创建默认分辨率草稿 -const defaultDraft = await createDraft(); - -// 创建720P草稿 -const hdDraft = await createDraft(1280, 720); - -// 创建正方形草稿 -const squareDraft = await createDraft(1080, 1080); - -console.log('草稿创建成功:', { - default: defaultDraft.draft_url, - hd: hdDraft.draft_url, - square: squareDraft.draft_url -}); +// 使用示例 +(async () => { + // 创建默认分辨率草稿 + const defaultDraft = await createDraft(); + + // 创建720P草稿 + const hdDraft = await createDraft(1280, 720); + + // 创建正方形草稿 + const squareDraft = await createDraft(1080, 1080); + + console.log('草稿创建成功:', { + default: defaultDraft.draft_url, + hd: hdDraft.draft_url, + square: squareDraft.draft_url + }); +})(); ``` -### 高级JavaScript示例 +#### 高级封装类 ```javascript class DraftManager { @@ -222,12 +242,14 @@ class DraftManager { const draftManager = new DraftManager(); // 创建单个草稿 -const draft = await draftManager.create1080p(); -console.log('草稿URL:', draft.draft_url); +draftManager.create1080p().then(draft => { + console.log('草稿URL:', draft.draft_url); +}); // 批量创建多种格式 -const multipleDrafts = await draftManager.createMultipleFormats(); -console.log('多种格式草稿:', multipleDrafts); +draftManager.createMultipleFormats().then(results => { + console.log('多种格式草稿:', results); +}); ``` ### Python 示例 @@ -320,10 +342,27 @@ for name, draft in drafts.items(): - **save_draft**: 保存草稿 - **gen_video**: 导出视频 -## 相关接口 +## 🔗 相关接口 -- [添加视频](./add_videos.md) -- [添加音频](./add_audios.md) -- [添加图片](./add_images.md) -- [保存草稿](./save_draft.md) -- [生成视频](./gen_video.md) \ No newline at end of file +
+ +### 📚 导航指南 + +**🎯 新手路径**: [首页文档](./index.md) ← 当前位置 → [添加视频](./add_videos.md) + +**🔄 工作流程**: 创建草稿 → **当前: CREATE_DRAFT** → [添加素材](./add_videos.md) → [生成视频](./gen_video.md) + +**📖 相关文档**: +- [项目概览](./index.md) - 了解完整功能 +- [添加视频](./add_videos.md) - 添加视频素材 +- [保存草稿](./save_draft.md) - 保存草稿更改 + +
+ +--- + +
+ +**📚 项目资源**: [GitHub](https://github.com/Hommy-master/capcut-mate) | [Gitee](https://gitee.com/taohongmin-gitee/capcut-mate) + +
\ No newline at end of file diff --git a/docs/gen_video.md b/docs/gen_video.md index dd5bee2..360a0d5 100644 --- a/docs/gen_video.md +++ b/docs/gen_video.md @@ -1,6 +1,19 @@ # gen_video 接口文档 -## 接口概述 +## 📋 目录 + +- [🔧 接口概述](#-接口概述) +- [🎯 功能描述](#-功能描述) +- [📥 请求参数](#-请求参数) +- [📤 响应格式](#-响应格式) +- [💻 使用示例](#-使用示例) +- [❌ 错误码说明](#-错误码说明) +- [⚠️ 注意事项](#️-注意事项) +- [🔄 工作流程](#-工作流程) +- [➡️ 下一步操作](#️-下一步操作) +- [🔗 相关接口](#-相关接口) + +## 🔧 接口概述 **接口名称**:gen_video **接口地址**:`POST /openapi/capcut-mate/v1/gen_video` @@ -582,4 +595,12 @@ for name, result in batch_results.items(): - [添加视频](./add_videos.md) - [添加音频](./add_audios.md) - [添加图片](./add_images.md) -- [获取草稿](./get_draft.md) \ No newline at end of file +- [获取草稿](./get_draft.md) + +--- + +
+ +**📚 项目资源**: [GitHub](https://github.com/Hommy-master/capcut-mate) | [Gitee](https://gitee.com/taohongmin-gitee/capcut-mate) + +
\ No newline at end of file diff --git a/docs/get_draft.md b/docs/get_draft.md index 9bc9b04..5c99139 100644 --- a/docs/get_draft.md +++ b/docs/get_draft.md @@ -1,6 +1,18 @@ # GET_DRAFT API 接口文档 -## 接口信息 +## 📋 目录 + +- [🔧 接口信息](#-接口信息) +- [🎯 功能描述](#-功能描述) +- [📖 更多文档](#-更多文档) +- [📥 请求参数](#-请求参数) +- [📤 响应格式](#-响应格式) +- [💻 使用示例](#-使用示例) +- [❌ 错误码说明](#-错误码说明) +- [⚠️ 注意事项](#️-注意事项) +- [🔗 相关接口](#-相关接口) + +## 🔧 接口信息 ``` GET /openapi/capcut-mate/v1/get_draft @@ -572,3 +584,11 @@ print("停止监控") - [添加音频](./add_audios.md) - [添加图片](./add_images.md) - [生成视频](./gen_video.md) + +--- + +
+ +**📚 项目资源**: [GitHub](https://github.com/Hommy-master/capcut-mate) | [Gitee](https://gitee.com/taohongmin-gitee/capcut-mate) + +
diff --git a/docs/index.md b/docs/index.md index ca8e409..dbebb48 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,6 +4,22 @@ CapCut Mate API 是一个基于 FastAPI 构建的剪映小助手,为开发者提供强大的视频编辑自动化能力。通过 RESTful API 接口,您可以轻松创建、编辑和渲染视频内容,无需手动操作剪映软件。 +> **🔗 项目地址**: [GitHub](https://github.com/Hommy-master/capcut-mate) | [Gitee](https://gitee.com/taohongmin-gitee/capcut-mate) + +## 📑 目录 + +- [📖 项目简介](#-项目简介) +- [✨ 核心功能](#-核心功能) +- [🚀 快速开始](#-快速开始) +- [📚 API 接口文档](#-api-接口文档) +- [🏗️ 系统架构](#️-系统架构) +- [🔄 典型工作流程](#-典型工作流程) +- [📊 API 使用统计](#-api-使用统计) +- [⚡ 性能优化](#-性能优化) +- [🔧 更多文档](#-更多文档) +- [💬 技术支持](#-技术支持) +- [📄 许可证](#-许可证) + ## ✨ 核心功能 ### 🎬 视频制作流程 @@ -24,110 +40,153 @@ CapCut Mate API 是一个基于 FastAPI 构建的剪映小助手,为开发者 ## 🚀 快速开始 -### 环境要求 +### 环境准备 -- Python 3.11+ -- 剪映软件(用于视频渲染) -- uv 包管理器 +在开始使用 CapCut Mate API 之前,请确保您具备以下条件: -### 安装部署 +- 🌐 **网络环境**: 能够访问 API 服务地址 +- 🔑 **API 权限**: 已获得相应的 API 访问权限 +- 📚 **开发环境**: 支持 HTTP 请求的开发环境 -```bash -# 1. 克隆项目 -git clone https://github.com/Hommy-master/capcut-mate.git -cd capcut-mate +### 📋 API 调用流程 -# 2. 安装依赖 -uv sync +CapCut Mate API 的典型使用流程如下: -# 3. 启动服务 -uv run main.py - -# 4. 或使用 Docker -docker pull gogoshine/capcut-mate:latest +```mermaid +graph TD + A[创建草稿] --> B[添加视频素材] + B --> C[添加音频素材] + C --> D[添加字幕] + D --> E[添加特效] + E --> F[生成视频] + F --> G[保存草稿] ``` -### 基础使用 +### 💻 快速示例 -```bash -# 创建草稿 -curl -X POST "http://localhost:60000/openapi/capcut-mate/v1/create_draft" \ - -H "Content-Type: application/json" \ - -d '{"width": 1920, "height": 1080}' +#### Python 示例 -# 添加视频素材 -curl -X POST "http://localhost:60000/openapi/capcut-mate/v1/add_videos" \ - -H "Content-Type: application/json" \ - -d '{ - "draft_url": "YOUR_DRAFT_URL", - "video_infos": "[{\"video_url\":\"https://assets.jcaigc.cn/video.mp4\",\"width\":1920,\"height\":1080,\"start\":0,\"end\":5000000,\"duration\":10000000}]" - }' +```python +import requests +import json -# 生成视频 -curl -X POST "http://localhost:60000/openapi/capcut-mate/v1/gen_video" \ - -H "Content-Type: application/json" \ - -d '{"draft_url": "YOUR_DRAFT_URL"}' +# 1. 创建草稿 +def create_draft(): + url = "https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/create_draft" + payload = { + "aspect_ratio": 1, # 16:9 横屏 + "duration": 60000000 # 60秒 + } + + response = requests.post(url, json=payload) + return response.json() + +# 2. 添加视频 +result = create_draft() +draft_url = result["data"]["draft_url"] + +# 继续添加其他素材... +print(f"草稿创建成功: {draft_url}") +``` + +#### JavaScript 示例 + +```javascript +// 创建草稿 +async function createDraft() { + const response = await fetch('https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/create_draft', { + method: 'POST', + headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify({ + aspect_ratio: 1, + duration: 60000000 + }) + }); + + const result = await response.json(); + return result.data.draft_url; +} + +// 使用示例 +createDraft().then(draftUrl => { + console.log('草稿创建成功:', draftUrl); + // 继续添加其他素材... +}); ``` ## 📚 API 接口文档 +CapCut Mate API 提供以下核心接口,支持完整的视频创作工作流程: + ### 🏗️ 草稿管理 -| 接口 | 功能 | 描述 | -|------|------|------| -| [create_draft](./create_draft.md) | 创建草稿 | 创建新的剪映草稿项目,设置画布尺寸 | -| [save_draft](./save_draft.md) | 保存草稿 | 保存当前草稿状态,确保编辑内容持久化 | -| [get_draft](./get_draft.md) | 获取草稿 | 获取草稿文件列表和详细信息 | +| 接口 | 功能 | 描述 | 文档链接 | +|------|------|------|----------| +| **create_draft** | 创建草稿 | 创建新的剪映草稿项目,设置画布尺寸 | [📖 查看文档](./create_draft.md) | +| **save_draft** | 保存草稿 | 保存当前草稿状态,确保编辑内容持久化 | [📖 查看文档](./save_draft.md) | +| **get_draft** | 获取草稿 | 获取草稿文件列表和详细信息 | [📖 查看文档](./get_draft.md) | ### 🎥 视频素材 -| 接口 | 功能 | 描述 | -|------|------|------| -| [add_videos](./add_videos.md) | 添加视频 | 批量添加视频素材,支持裁剪、缩放、特效 | -| [add_images](./add_images.md) | 添加图片 | 批量添加图片素材,支持动画和转场效果 | -| [add_sticker](./add_sticker.md) | 添加贴纸 | 添加装饰贴纸,支持位置和大小调整 | +| 接口 | 功能 | 描述 | 文档链接 | +|------|------|------|----------| +| **add_videos** | 添加视频 | 批量添加视频素材,支持裁剪、缩放、特效 | [📖 查看文档](./add_videos.md) | +| **add_images** | 添加图片 | 批量添加图片素材,支持动画和转场效果 | [📖 查看文档](./add_images.md) | +| **add_sticker** | 添加贴纸 | 添加装饰贴纸,支持位置和大小调整 | [📖 查看文档](./add_sticker.md) | ### 🎵 音频处理 -| 接口 | 功能 | 描述 | -|------|------|------| -| [add_audios](./add_audios.md) | 添加音频 | 批量添加音频素材,支持音量和淡入淡出 | -| [get_audio_duration](./get_audio_duration.md) | 获取音频时长 | 获取音频文件的精确时长信息 | +| 接口 | 功能 | 描述 | 文档链接 | +|------|------|------|----------| +| **add_audios** | 添加音频 | 批量添加音频素材,支持音量和淡入淡出 | [📖 查看文档](./add_audios.md) | +| **get_audio_duration** | 获取音频时长 | 获取音频文件的精确时长信息 | [📖 查看文档](./get_audio_duration.md) | ### 📝 文本字幕 -| 接口 | 功能 | 描述 | -|------|------|------| -| [add_captions](./add_captions.md) | 添加字幕 | 批量添加字幕,支持关键词高亮和样式设置 | -| [add_text_style](./add_text_style.md) | 文本样式 | 创建富文本样式,支持关键词颜色和字体 | +| 接口 | 功能 | 描述 | 文档链接 | +|------|------|------|----------| +| **add_captions** | 添加字幕 | 批量添加字幕,支持关键词高亮和样式设置 | [📖 查看文档](./add_captions.md) | +| **add_text_style** | 文本样式 | 创建富文本样式,支持关键词颜色和字体 | [📖 查看文档](./add_text_style.md) | ### ✨ 特效动画 -| 接口 | 功能 | 描述 | -|------|------|------| -| [add_effects](./add_effects.md) | 添加特效 | 添加视觉特效,如滤镜、边框、动态效果 | -| [add_keyframes](./add_keyframes.md) | 关键帧动画 | 创建位置、缩放、旋转等属性动画 | -| [add_masks](./add_masks.md) | 遮罩效果 | 添加各种形状遮罩,控制画面可见区域 | +| 接口 | 功能 | 描述 | 文档链接 | +|------|------|------|----------| +| **add_effects** | 添加特效 | 添加视觉特效,如滤镜、边框、动态效果 | [📖 查看文档](./add_effects.md) | +| **add_keyframes** | 关键帧动画 | 创建位置、缩放、旋转等属性动画 | [📖 查看文档](./add_keyframes.md) | +| **add_masks** | 遮罩效果 | 添加各种形状遮罩,控制画面可见区域 | [📖 查看文档](./add_masks.md) | ### 🎨 动画资源 -| 接口 | 功能 | 描述 | -|------|------|------| -| [get_text_animations](./get_text_animations.md) | 文本动画 | 获取可用的文本入场、出场、循环动画 | -| [get_image_animations](./get_image_animations.md) | 图片动画 | 获取可用的图片动画效果列表 | +| 接口 | 功能 | 描述 | 文档链接 | +|------|------|------|----------| +| **get_text_animations** | 文本动画 | 获取可用的文本入场、出场、循环动画 | [📖 查看文档](./get_text_animations.md) | +| **get_image_animations** | 图片动画 | 获取可用的图片动画效果列表 | [📖 查看文档](./get_image_animations.md) | ### 🎬 视频生成 -| 接口 | 功能 | 描述 | -|------|------|------| -| [gen_video](./gen_video.md) | 生成视频 | 提交视频渲染任务,异步处理 | -| [gen_video_status](./gen_video_status.md) | 查询状态 | 查询视频生成任务的进度和状态 | +| 接口 | 功能 | 描述 | 文档链接 | +|------|------|------|----------| +| **gen_video** | 生成视频 | 提交视频渲染任务,异步处理 | [📖 查看文档](./gen_video.md) | +| **gen_video_status** | 查询状态 | 查询视频生成任务的进度和状态 | [📖 查看文档](./gen_video_status.md) | ### 🚀 快速工具 -| 接口 | 功能 | 描述 | -|------|------|------| -| [easy_create_material](./easy_create_material.md) | 快速创建 | 一次性添加多种类型素材,简化创建流程 | +| 接口 | 功能 | 描述 | 文档链接 | +|------|------|------|----------| +| **easy_create_material** | 快速创建 | 一次性添加多种类型素材,简化创建流程 | [📖 查看文档](./easy_create_material.md) | + +### 🔗 快速导航 + +
+ +**🎯 新手入门**: [创建草稿](./create_draft.md) → [添加视频](./add_videos.md) → [生成视频](./gen_video.md) + +**🎨 进阶创作**: [添加字幕](./add_captions.md) → [添加特效](./add_effects.md) → [添加音频](./add_audios.md) + +**💾 项目管理**: [保存草稿](./save_draft.md) → [查看草稿](./get_draft.md) + +
## 🏗️ 系统架构 @@ -227,23 +286,42 @@ graph TB ### 获取帮助 -- **交互式文档**: 访问 `http://localhost:60000/docs` 查看 Swagger UI -- **问题反馈**: 提交 GitHub Issues -- **商业合作**: 联系邮箱 taohongmin51@gmail.com +- **📖 交互式文档**: 访问 `http://localhost:60000/docs` 查看 Swagger UI +- **🐛 问题反馈**: 提交 [GitHub Issues](https://github.com/Hommy-master/capcut-mate/issues) 或 [Gitee Issues](https://gitee.com/taohongmin-gitee/capcut-mate/issues) +- **📧 商业合作**: 联系邮箱 `taohongmin51@gmail.com` +- **💬 社区讨论**: 欢迎提交 Pull Request 来改进项目 ### 贡献指南 欢迎提交 Pull Request 来改进项目: -1. Fork 项目 -2. 创建功能分支 -3. 提交更改 -4. 创建 Pull Request +1. 🍴 Fork 项目 +2. 🌿 创建功能分支 +3. 📝 提交更改 +4. 🚀 创建 Pull Request -## 📄 许可证 +### 开源地址 -本项目采用 MIT 许可证,详情请查看 LICENSE 文件。 +
+ +[![GitHub](https://img.shields.io/badge/GitHub-Repository-blue?style=flat-square&logo=github)](https://github.com/Hommy-master/capcut-mate) +[![Gitee](https://img.shields.io/badge/Gitee-Repository-red?style=flat-square&logo=gitee)](https://gitee.com/taohongmin-gitee/capcut-mate) + +**GitHub**: [https://github.com/Hommy-master/capcut-mate](https://github.com/Hommy-master/capcut-mate) +**Gitee**: [https://gitee.com/taohongmin-gitee/capcut-mate](https://gitee.com/taohongmin-gitee/capcut-mate) + +
--- -**CapCut Mate API** - 让视频创作更简单、更高效! \ No newline at end of file +## 📄 许可证 + +本项目采用 MIT 许可证,详情请查看 [LICENSE](https://github.com/Hommy-master/capcut-mate/blob/main/LICENSE) 文件。 + +
+ +**CapCut Mate API** - 让视频创作更简单、更高效! + +⭐ 如果这个项目对您有帮助,请给我们一个 Star! + +
\ No newline at end of file diff --git a/docs/save_draft.md b/docs/save_draft.md index 07c9b98..011b14f 100644 --- a/docs/save_draft.md +++ b/docs/save_draft.md @@ -1,6 +1,18 @@ # SAVE_DRAFT API 接口文档 -## 接口信息 +## 📋 目录 + +- [🔧 接口信息](#-接口信息) +- [🎯 功能描述](#-功能描述) +- [📖 更多文档](#-更多文档) +- [📥 请求参数](#-请求参数) +- [📤 响应格式](#-响应格式) +- [💻 使用示例](#-使用示例) +- [❌ 错误码说明](#-错误码说明) +- [⚠️ 注意事项](#️-注意事项) +- [🔗 相关接口](#-相关接口) + +## 🔧 接口信息 ``` POST /openapi/capcut-mate/v1/save_draft @@ -315,4 +327,12 @@ saver.stop_auto_save(auto_save_id) - [添加视频](./add_videos.md) - [添加音频](./add_audios.md) - [添加图片](./add_images.md) -- [生成视频](./gen_video.md) \ No newline at end of file +- [生成视频](./gen_video.md) + +--- + +
+ +**📚 项目资源**: [GitHub](https://github.com/Hommy-master/capcut-mate) | [Gitee](https://gitee.com/taohongmin-gitee/capcut-mate) + +
\ No newline at end of file