介绍 PlanetScale API 和 OAuth 应用

今天，我们发布了一种新的方式，通过编程方式管理您的 PlanetScale 数据库：PlanetScale API。

PlanetScale API

这个 API 提供了与 PlanetScale 交互的新途径，通过自动化和其他开发者工具（如 CI/CD、基础设施即代码、部署工具和应用平台），用户可以将 PlanetScale 的功能无缝集成到现有工作流程中，例如分支管理、部署请求、密码管理等。

此外，我们还试行了 OAuth 应用 的有限测试版。OAuth 应用结合 PlanetScale API，可以使用户通过您的平台与他们的 PlanetScale 数据库交互。

PlanetScale API 功能

通过 PlanetScale API，用户可以完成从简单任务到复杂的操作，例如：

自动创建和删除数据库分支（如 CI/CD 管道或数据迁移工具）。
程序化地为测试构建新的环境并连接到 PlanetScale 数据库分支。
获取 PlanetScale 用户、数据库、分支、组织和部署请求的信息。
检查部署队列中部署请求的状态。
自动创建和删除供内部用户或工具使用的数据库连接字符串。
程序化地创建、更新、批准、部署和删除部署请求，从 PlanetScale 之外的工具执行这些操作。

通过 API 提供这些操作，开发者可以更轻松的实现自动化流程并创建强大的工作流，从而获得更快速和丰富的开发体验。

使用 PlanetScale API

授权

要开始使用 PlanetScale API，只需创建一个服务令牌（service token），并根据 API 文档中描述的访问权限授予所需的端点权限。每个端点的文档中都会明确列出服务令牌需要使用的访问权限。

请求与响应

在拥有服务令牌后，用户可以填写 API 参考中的请求参数，并直接从文档复制代码来执行操作：

API 请求与响应在文档中详细说明

OAuth 应用

结合 PlanetScale API，PlanetScale OAuth 应用让您的平台与 PlanetScale 完美集成，同时允许用户为您的平台提供精细化的 PlanetScale 账户访问权限。

加入有限测试版

如果您想创建自己的 PlanetScale OAuth 应用，可以通过 PlanetScale 组织的 Settings > Beta features 页面加入候选名单。一旦您的注册请求被接受，PlanetScale 团队将与您联系并讨论您的 OAuth 用例。

PlanetScale API 和 OAuth 应用演示

我们构建了一个基于 Next.js 的演示应用 PlanetPets，展示了如何结合 PlanetScale OAuth 和 API 访问用户的组织、数据库和分支，并创建新分支。在 PlanetPets 中，用户的组织被呈现为“花园”，其中的数据库是“树”，可以给“树”浇水以生成新的分支。

PlanetScale 集成示例

两位社区合作伙伴已经使用 OAuth 应用和 PlanetScale API 开发了集成功能，这些功能可供用户使用。

Netlify

Netlify 推出了面向 Netlify Labs 的新 PlanetScale 集成。此集成允许 Netlify 用户将 PlanetScale 的分支、部署请求、密码管理等功能直接集成到 Netlify 工作流中。额外的好处包括：

更轻松地将 PlanetScale 数据库连接到 Netlify 站点。
为每个部署上下文分配不同的数据库分支。
在 Netlify Functions 中使用 withPlanetScale 函数无缝调用数据库连接。

Resmo

Resmo 通过 OAuth 应用和 PlanetScale API 实现快速连接，为用户提供 PlanetScale 数据库的资源可见性、持续安全性和合规性管理。Resmo 收集来自 PlanetScale 用户账户的资源（如数据库、组织和数据库分支），以实现用户查询、设置自定义安全规则并自动化安全检查。

PlanetScale API 和 OAuth 应用的推出使得用户管理和集成数据库变得更加高效。您可以立即尝试使用这些工具，为开发工作流赋能。

介绍 PlanetScale API 和 OAuth 应用插图