mcpField
V
viewcomfy-api-rules

viewcomfy-api-rules

github.com/mindrally创意与媒体287667 次安装3 周前更新
代码仓库

关于 viewcomfy-api-rules

用于在 Python Web 应用中集成 ViewComfy API 的技能,说明工作流设置、请求方式、结果处理,以及冷启动和长时生成等运行注意事项。

主要功能

  1. 01ViewComfy 工作流部署步骤
  2. 02参数提取与校验
  3. 03标准及流式 API 请求
  4. 04Base64 结果解码与保存
  5. 05凭据和错误处理指南

适用场景

  1. 01将 Python Web 应用连接到 ViewComfy
  2. 02跟踪长时间运行的工作流
  3. 03保存 API 响应中的生成文件

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/mindrally/skills --skill viewcomfy-api-rules

安装后在 Claude Code 中输入/viewcomfy-api-rules确认已加载。

详细介绍

ViewComfy API 规则

你是一名精通 Python、FastAPI 集成和 Web 应用开发的专家,负责协助使用 Python 将 ViewComfy API 集成到 Web 应用中。

关键技术背景

ViewComfy API 是一项基于 FastAPI 的无服务器服务,可执行自定义 ComfyUI 工作流。实现中使用 httpx 库发送请求。

重要操作注意事项

冷启动与性能

首次调用时可能会遇到冷启动。生成时间因工作流而异:有些不到 2 秒,有些则需要几分钟。

参数要求

params 对象不能为空。如果未指定参数,请修改 seed 值。

API 响应格式

结果会以以下结构返回:

  • prompt_id:唯一标识符
  • status:执行状态
  • completed:表示是否完成的布尔值
  • execution_time_seconds:处理时长
  • prompt:原始配置
  • outputs:生成文件数组(可选,包含文件名、content_type、经过 base64 编码的数据和大小)

实现工作流

  1. 使用 workflow_api.json 通过 ViewComfy 控制面板部署 ComfyUI 工作流
  2. 使用 workflow_parameters_maker.py 提取参数并展平配置
  3. 在实现中配置端点 URL、Client ID 和 Client Secret
  4. 使用 infer(标准 POST)或 infer_with_logs(用于实时跟踪的流式 SSE)调用 API
  5. 对输出进行 base64 解码,并保存到工作目录

最佳实践

  • 始终在应用中妥善处理冷启动延迟
  • 为 API 响应实现适当的错误处理
  • 对于长时间运行的工作流,使用流式端点(infer_with_logs)向用户提供反馈
  • 安全存储凭据,绝不要在客户端代码中暴露凭据
  • 发送请求前验证参数,避免不必要的 API 调用

评论

支持 Markdown