本文档由 AI 自动翻译。如有任何不准确之处,请参考 英文原版。
你将构建什么#
完成本指南后,你将创建一个 Dify 插件,它能够:
- 连接到 Flomo 笔记 API
- 允许用户将 AI 对话中的笔记直接保存到 Flomo
- 正确处理身份验证和错误状态
- 准备好在 Dify 市场中分发
10 分钟
基本的 Python 知识和一个 Flomo 账户
步骤 1:安装 Dify 插件 CLI 并创建项目#
安装 Dify 插件 CLI
从 Dify Plugin Daemon releases 页面 下载最新的二进制文件。x86_64 选择 dify-plugin-linux-amd64,ARM 选择 dify-plugin-linux-arm64。
验证安装:
初始化插件项目
使用以下命令创建新的插件项目:
按照提示设置你的插件:
- 将其命名为
flomo - 选择
tool作为插件类型 - 完成其余必填字段
导航到项目目录
该项目包含你的插件的基本结构,以及所有必要的文件。
步骤 2:定义插件清单#
manifest.yaml 文件定义了插件的元数据、权限和功能。
创建 manifest.yaml 文件:
步骤 3:创建工具定义#
工具插件使用两个 YAML 文件:一个 provider 文件用于声明凭证并列出工具,以及每个可调用工具对应一个 tool 文件。完整的 schema 请参阅通用规范。
创建 provider/flomo.yaml:
创建 tools/flomo.yaml:
步骤 4:实现核心工具函数#
在 utils/flomo_utils.py 中创建用于 API 交互的工具模块:
步骤 5:实现工具提供者#
工具提供者处理凭证验证。创建 provider/flomo.py:
步骤 6:实现工具#
工具类处理用户调用插件时的实际 API 调用。创建 tools/flomo.py:
始终优雅地处理异常并返回用户友好的错误消息。请记住,你的插件代表着你在 Dify 生态系统中的品牌形象。
步骤 7:测试你的插件#
设置调试环境
复制示例环境文件:
使用你的 Dify 环境详情编辑 .env 文件:
你可以在 Dify 仪表板中找到你的调试 URL 和密钥:点击右上角的插件图标,然后点击调试图标。复制 API Key 和 Host Address(主机地址已包含端口)。
安装依赖并运行
你的插件将以调试模式连接到你的 Dify 实例。
测试功能
在你的 Dify 实例中,打开 插件 页面并找到你的插件(标记为 debugging )。添加你的 Flomo API 凭证并测试发送笔记。
步骤 8:打包和分发#
当你准备好分享你的插件时:
这将创建一个 plugin.difypkg 文件,你可以将其上传到 Dify 市场。
常见问题和故障排除#
插件在调试模式下不显示
确保你的 .env 文件配置正确,并且你使用的是正确的调试密钥。
API 身份验证错误
仔细检查你的 Flomo API URL 格式。它应该是这种形式:https://flomoapp.com/iwh/{token}/{secret}/
打包失败
确保所有必需的文件都存在,并且 manifest.yaml 结构有效。
总结#
你已经构建了一个连接外部 API 服务的功能性 Dify 插件。这种相同的模式适用于与数千种服务的集成,从数据库、搜索引擎到生产力工具和自定义 API。
用英文(en_US)编写你的 README.md,描述功能、设置和使用示例
为其他语言创建额外的 README 文件,如 readme/README_zh_Hans.md