Dify
开始
因为 Dify API Extension 需要使用可以访问的公网地址作为 API Endpoint,所以我们需要将 API 扩展部署到一个公网地址上。这里我们使用 Cloudflare Workers 来部署我们的 API 扩展。
我们 Clone Example GitHub Repository,这个仓库包含了一个简单的 API 扩展,我们可以在这个基础上进行修改。
打开 wrangler.toml
文件,修改 name
和 compatibility_date
为你的应用名称和兼容日期。
这里我们我们需要注意的配置就是 vars
里面的 TOKEN
,在 Dify 添加 API 扩展的时候,我们需要填写这个 Token。出于安全考虑,我们建议你使用一个随机的字符串作为 Token,你不应该在源代码中直接写入 Token,而是使用环境变量的方式来传递 Token。所以请不要把 wrangler.toml 提交到你的代码仓库中。
这个 API 扩展会返回一个随机的 Breaking Bad 名言。你可以在 src/index.ts
中修改这个 API 扩展的逻辑。这个例子展示了与第三方 API 进行交互的方式。
这个仓库简化了除了业务逻辑之外所有的配置,你可以直接使用 npm
命令来部署你的 API 扩展。
部署成功之后,你会得到一个公网地址,你可以在 Dify 中添加这个地址作为 API Endpoint。请注意不要遗漏 endpoint
这个路径,此路径的具体定义在 src/index.ts
中可以查看。
另外,也可以直接使用 npm run dev
命令来部署到本地进行测试。
相关输出:
之后就可以使用 Postman 等工具进行本地接口调试。
其他逻辑
关于 Bearer Auth
我们的 Bearer 校验逻辑在如上代码中,我们使用了 hono/bearer-auth
这个包来实现 Bearer 校验。你可以在 src/index.ts
中使用 c.env.TOKEN
来获取 Token。
关于参数验证
我们这里使用了 zod
来定义参数的类型,你可以在 src/index.ts
中使用 zValidator
来校验参数。通过 const { point, params } = c.req.valid("json");
来获取校验后的参数。 我们这里的 point 只有两个值,所以我们使用了 z.union
来定义。 params 是一个可选的参数,所以我们使用了 z.optional
来定义。 其中会有一个 inputs
的参数,这个参数是一个 Record<string, any>
类型,这个类型表示一个 key 为 string,value 为 any 的对象。这个类型可以表示任意的对象,你可以在 src/index.ts
中使用 params?.inputs?.count
来获取 count
参数。