使用 Supabase 开发边缘函数
在 Supabase 仪表板中开始使用边缘函数。
在本指南中,我们将介绍如何在 Supabase 仪表板上创建一个基础边缘函数,并使用 Supabase CLI 进行访问。
从仪表板部署
进入您的项目 > 边缘函数 > 部署新函数 > 通过编辑器
这将为您搭建一个新函数。您可以从模板中选择一些预定义的常用场景函数。
根据需要修改函数,为其命名,然后点击部署函数
。
您的函数现已激活。导航至函数详情页面,点击测试按钮。
您可以通过提供预期的 HTTP 方法、请求头、查询参数和请求体来测试函数。还可以更改传递的授权令牌(例如匿名密钥或用户密钥)。
通过 Supabase CLI 访问已部署的函数
未安装 CLI?
请查看 CLI 文档 了解如何在本地机器上安装 Supabase CLI。
现在您的函数已部署,您可以从本地开发环境访问它。具体步骤如下:
-
将项目链接到本地环境
您可以在 Supabase 仪表板的 URL 或项目设置中找到项目引用 ID。
1supabase link --project-ref your-project-ref -
列出链接项目中的所有函数
1supabase functions list -
访问您要处理的特定函数
1supabase functions download function-name -
根据需要对函数代码进行本地编辑
-
在重新部署前本地运行您的函数
1supabase functions serve function-name -
准备好更改后重新部署
1supabase functions deploy function-name
通过助手部署
您还可以利用 Supabase 助手来帮助编写和部署边缘函数。
进入您的项目 > 边缘函数 > 点击助手图标选择"使用 Supabase 助手创建"
这将打开一个助手窗口,其中预填了用于生成边缘函数的提示。 描述您的边缘函数需求,剩下的交给 Supabase 助手处理。
点击部署,助手将自动部署您的函数。
此函数需要 OpenAI API 密钥。您可以在边缘函数的密钥页面添加该密钥,或者寻求助手帮助。
- 导航至边缘函数 > 密钥页面
- 找到添加环境变量的选项
- 添加一个名为
OPENAI_API_KEY
的新环境变量,并将其值设为您的实际 OpenAI API 密钥
设置好这个环境变量后,您的边缘函数就能安全地访问 OPENAI_API_KEY,而无需将其硬编码到函数代码中。这是保护敏感信息的最佳实践。
设置好变量后,您可以通过仪表板发送请求进行测试。导航至函数的详情页面,点击测试按钮,然后提供函数期望的请求体。
通过仪表板编辑函数
请注意:当前编辑操作没有版本控制
仪表板的边缘函数编辑器目前不支持版本管理或回滚功能。我们建议仅将其用于快速测试和原型开发。当您准备投入生产环境时,请将边缘函数代码存储在源代码仓库(如 git)中,并使用CI集成进行部署。
-
在函数页面,点击您想要编辑的函数。进入函数详情页后,点击"代码"选项卡。
-
这将打开仪表板中的代码编辑器,您可以查看已部署函数的代码。
-
根据需要修改代码,然后点击"部署更新"。这将用新编辑的函数代码覆盖现有部署。
后续步骤
查看本地开发指南获取关于使用边缘函数的更多详细信息。
继续阅读了解一些常见开发技巧。