更新README文档

This commit is contained in:
puke
2025-06-21 20:28:35 +08:00
parent 4d4c71637d
commit da0848a621
4 changed files with 40 additions and 0 deletions
+20
View File
@@ -4,6 +4,26 @@ ComfyUI-OneAPI is a plugin that provides simple REST API interfaces for ComfyUI,
[中文文档](README_CN.md)
## 🎯 Why ComfyUI-OneAPI?
![ComfyUI-OneAPI Comparison](docs/compare.png)
### ✨ Core Features
- **Extreme Simplicity** - Execute complex ComfyUI workflows with just ONE API request
- **Dynamic Parameters** - Replace workflow parameters dynamically through node title markers
- **Multi-Source Support** - Support JSON objects, local files, and URLs as workflow inputs
- **Smart Output Management** - Automatically categorize and organize multiple output nodes
- **UI Integration** - Built-in right-click menus for workflow saving and parameter setting
- **Flexible Marking System** - Support input markers (`$param.field`) and output markers (`$output.name`)
### 🚀 Core Advantages
- **95% Code Reduction** - From hundreds of lines of complex logic to a single API call
- **Unified Error Handling** - Built-in comprehensive exception handling and error recovery
- **Parameterized Workflows** - Dynamic parameter replacement through node title markers
- **Intelligent File Processing** - Auto-handle image uploads, URL downloads, temp file management
- **Auto-categorized Results** - Smart classification of different output types
- **Zero Learning Curve** - Keep ComfyUI workflows unchanged, just add simple markers
## ⚡️ Quick Start
### 📦 Installation
+20
View File
@@ -4,6 +4,26 @@ ComfyUI-OneAPI 是一个为 ComfyUI 提供简单REST API接口的插件,只需
[English Documentation](README.md)
## 🎯 为什么选择 ComfyUI-OneAPI?
![ComfyUI-OneAPI 对比](docs/compare_zh.jpg)
### ✨ 核心特点
- **极简调用** - 只需一个REST API请求即可执行复杂的ComfyUI工作流
- **动态参数替换** - 通过节点标题标记实现参数动态替换,无需修改工作流文件
- **多种输入支持** - 支持JSON对象、本地文件名、URL三种workflow输入方式
- **智能输出管理** - 自动区分多个SaveImage节点输出,便于处理复杂工作流
- **UI界面集成** - 提供右键菜单快速保存API工作流和设置节点参数
- **灵活标记系统** - 支持输入参数标记(`$param.field`)和输出标记(`$output.name`)
### 🚀 核心优势
- **代码量减少95%** - 从数百行复杂逻辑简化为单个API调用
- **统一错误处理** - 内置完整的异常处理和错误恢复机制
- **参数化工作流** - 通过节点标题标记实现动态参数替换
- **智能文件处理** - 自动处理图片上传、URL下载、临时文件管理
- **结果自动分类** - 智能区分和分类不同类型的输出结果
- **零学习成本** - 保持ComfyUI工作流不变,仅需添加简单标记
## ⚡️ 快速开始
### 📦 安装
BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 2.6 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 358 KiB