Last updated
Last updated
本文将引导你快速开发一个 Extension 类型的插件，以帮助你了解插件开发的基础流程。
Dify 插件脚手架工具
Python 环境，版本号 ≥ 3.12
关于如何准备插件开发的脚手架工具，详细说明请参考。
在当前路径下，运行脚手架命令行工具，创建一个新的 dify 插件项目。
如果你已将该二进制文件重命名为了 dify 并拷贝到了 /usr/local/bin 路径下，可以运行以下命令创建新的插件项目：
按照提示配置插件名称、作者信息与插件描述。如果你是团队协作，也可以将作者填写为组织名。
插件名称长度必须为 1-128 个字符，并且只能包含字母、数字、破折号和下划线。
填写完成后，在插件开发语言环节中选择 Python。
插件还需要读取 Dify 主平台的权限才能正常连接。需要为该示例插件授予以下权限：
Tools
LLMs
Apps
启用持久化储存 Storage，分配默认大小存储
允许注册 Endpoint
在终端内使用方向键选择权限，使用 “Tab” 按钮授予权限。
勾选所有权限项后，轻点回车完成插件的创建。系统将自动生成插件项目代码。
插件的基础文件结构包含以下内容：
GUIDE.md 一个简短的引导教程，带领你完成插件的编写流程。
README.md 关于当前插件的简介信息，你需要把有关该插件的介绍和使用方法填写至该文件内。
_assets 存储所有与当前插件相关的多媒体文件。
endpoints 按照 cli 中的引导创建的一个 Extension 类型插件模板，该目录存放所有 Endpoint 的功能实现代码。
group 指定密钥类型、多语言设置以及 API 定义的文件路径。
main.py 整个项目的入口文件。
manifest.yaml 整个插件的基础配置文件，包含该插件需要什么权限、是什么类型的扩展等配置信息。
requirements.txt 存放 Python 环境的依赖项。
编辑 endpoints/test_plugin.yaml ，参考以下代码进行修改：
该代码的意图是定义该插件的入口路径为 /neko，请求方法为 GET 类型。插件的功能实现代码为 endpoints/test_plugin.py 文件。
插件功能：请求插件服务，输出一只猫。
编写插件的功能实现代码 endpoints/test_plugin.py 文件，参考以下示例代码：
运行此代码需要先安装以下 Python 依赖包：
接下来需测试插件是否可以正常运行。Dify 提供远程调试方式，前往“插件管理”页获取调试 Key 和远程服务器地址。
回到插件项目，拷贝 .env.example 文件并重命名为 .env，将获取的远程服务器地址和调试 Key 等信息填入其中。
.env 文件
运行 python -m main 命令启动插件。在插件页即可看到该插件已被安装至 Workspace 内。其他团队成员也可以访问该插件。
在插件内新增 Endpoint，随意填写名称和 api_key 等信息。访问自动生成的 URL，即可看到由插件提供的网页服务。
确认插件能够正常运行后，可以通过以下命令行工具打包并命名插件。运行以后你可以在当前文件夹发现 neko.difypkg 文件，该文件为最终的插件包。
恭喜，你已完成一个插件的完整开发、测试打包过程！
快速开始：
插件接口文档：
最佳实践：
脚手架工具内的所有模板均已提供完整的代码项目。出于演示说明，本文将以 Extension 类型插件模板作为示例。对于已熟悉插件的开发者而言，无需借助模板，可参考指引完成不同类型的插件开发。
现在可以将它上传至 来发布你的插件了！上传前，请确保你的插件遵循了。审核通过后，代码将合并至主分支并自动上线至 。
结构
详细定义
