管理 Data App
Data Service (beta) 中的 Data App 是一组用于访问特定应用程序数据的端点集合。你可以使用 API 密钥配置授权设置，以限制对 Data App 中端点的访问。
本文档介绍如何在 TiDB Cloud 控制台中管理你的 Data Apps。在 Data Service 页面，你可以管理所有 Data Apps、端点和 API 密钥。
创建 Data App
要为你的项目创建 Data App，请执行以下步骤：
在项目的 Data Service 页面，点击左侧窗格中的 Create DataApp。
提示：
如果这是你项目中的第一个 Data App，请点击页面中间的 Create Data App。
输入名称、描述，并选择你希望 Data App 访问的集群。
（可选）要将 Data App 的端点自动部署到你首选的 GitHub 仓库和分支，请启用 Connect to GitHub，然后执行以下操作：
点击 Install on GitHub，然后按照屏幕上的说明将 TiDB Cloud Data Service 作为应用程序安装到你的目标仓库。
点击 Authorize 以授权访问 GitHub 上的应用程序。
指定要保存 Data App 配置文件的目标仓库、分支和目录。
点击 Create Data App。
新创建的 Data App 将添加到列表顶部。系统会为新的 Data App 创建一个默认的
untitled endpoint。如果你已配置将 Data App 连接到 GitHub，请检查你指定的 GitHub 目录。你会发现 Data App 配置文件已由
tidb-cloud-data-service提交到该目录，这表示你的 Data App 已成功连接到 GitHub。对于你的新 Data App，默认启用 Auto Sync & Deployment 和 Review Draft，以便你可以轻松地在 TiDB Cloud 控制台和 GitHub 之间同步 Data App 更改，并在部署前审查更改。有关 GitHub 集成的更多信息，请参阅使用 GitHub 自动部署 Data App 更改。
配置 Data App
你可以编辑 Data App 的名称、版本或描述，并管理其 GitHub 连接、链接的数据源、API 密钥、端点和部署。
编辑 Data App 属性
你可以编辑 Data App 的名称、版本和描述。要编辑 Data App 属性，请执行以下步骤：
- 导航到项目的 Data Service 页面。
- 在左侧窗格中，点击目标 Data App 的名称以查看其详细信息。
- 在 Data App Properties 区域，点击 ，修改 App 名称、版本或描述，然后点击 Confirm。
管理 GitHub 连接
有关更多信息，请参阅使用 GitHub 自动部署。
管理链接的数据源
你可以为 Data App 添加或删除链接的集群。
要将集群链接到 Data App，请执行以下步骤：
- 导航到项目的 Data Service 页面。
- 在左侧窗格中，找到目标 Data App 并点击其名称以查看详细信息。
- 在 Linked Data Sources 区域，点击 Add Cluster。
- 在显示的对话框中，从列表中选择一个集群，然后点击 Add。
要从 Data App 中删除链接的集群，请执行以下步骤：
导航到项目的 Data Service 页面。
在左侧窗格中，找到目标 Data App 并点击其名称以查看详细信息。
在 Linked Data Sources 区域，找到要从 Data App 中删除的目标链接集群，然后在 Action 列中点击 Delete。
在显示的对话框中确认删除。
删除链接的集群后，该集群不会被删除，但 Data App 中的现有端点将无法访问它。
管理 API 密钥
有关更多信息，请参阅管理 API 密钥。
管理端点
有关更多信息，请参阅管理端点。
管理自定义域名
有关更多信息，请参阅管理自定义域名。
管理部署
要管理部署，请执行以下步骤：
导航到项目的 Data Service 页面。
在左侧窗格中，找到目标 Data App 并点击其名称以查看详细信息。
在 Deployment Configuration 区域，点击 Config。将显示部署配置对话框。
在对话框中，选择你想要的 Auto Sync & Deployment 和 Review Draft 设置。
Auto Sync & Deployment
- 此选项仅在你的 Data App 连接到 GitHub 时才能启用。有关更多信息，请参阅使用 GitHub 自动部署。
- 启用后，在你指定的 GitHub 目录中所做的更改可以自动部署到 TiDB Cloud，在 TiDB Cloud 控制台中所做的更改也可以推送到 GitHub。你可以在 Data App 部署历史记录中找到相应的部署和提交信息。
- 禁用后，在你指定的 GitHub 目录中所做的更改将不会部署到 TiDB Cloud，在 TiDB Cloud 控制台中所做的更改也将不会推送到 GitHub。
Review Draft
- 启用后，你可以在部署前审查在 TiDB Cloud 控制台中所做的 Data App 更改。根据审查结果，你可以选择部署或放弃更改。
- 禁用后，在 TiDB Cloud 控制台中所做的 Data App 更改将直接部署。
在 Action 列中，你可以根据需要编辑或重新部署更改。
使用 OpenAPI 规范
Data Service (beta) 支持为每个 Data App 生成 OpenAPI 规范 3.0，使你能够以标准化格式与端点交互。你可以使用此规范生成标准化的 OpenAPI 文档、客户端 SDK 和服务器存根。
下载 OpenAPI 规范
要以 JSON 或 YAML 格式下载 Data App 的 OpenAPI 规范，请执行以下步骤：
导航到项目的 Data Service 页面。
在左侧窗格中，点击目标 Data App 的名称以查看其详细信息。
在 API Specification 区域，点击 Download 并选择 JSON 或 YAML。
如果这是你第一次下载 OpenAPI 规范，系统会提示你授权请求。
然后，OpenAPI 规范将下载到你的本地计算机。
查看 OpenAPI 文档
Data Service (beta) 为每个 Data App 提供自动生成的 OpenAPI 文档。在文档中，你可以查看端点、参数和响应，并试用端点。
要访问 OpenAPI 文档，请执行以下步骤：
导航到项目的 Data Service 页面。
在左侧窗格中，点击目标 Data App 的名称以查看其详细信息。
在页面右上角，点击 View API Docs。
如果这是你第一次使用 OpenAPI 规范，系统会提示你授权请求。
然后，OpenAPI 文档将在新标签页中打开。在文档中，你可以查看以下信息：
- Data App 名称、版本和描述。
- 按标签分组的端点。
（可选）要试用端点，请执行以下步骤：
点击 Authorize 并在显示的对话框中输入你的 Data App 公钥作为 Username 和私钥作为 Password。
有关更多信息，请参阅管理 API 密钥。
找到目标端点，提供所需参数，然后点击 Try it out。你可以在 Response body 区域查看响应。
有关如何使用 OpenAPI 文档的更多信息，请参阅 Swagger UI。
删除 Data App
要删除 Data App，请执行以下步骤：
导航到项目的 Data Service 页面。
在左侧窗格中，找到目标 Data App 并点击其名称以查看详细信息。
在 Danger Zone 区域，点击 Delete Data App。将显示确认对话框。
输入你的
<organization name>/<project name>/<data app name>，然后点击 I understand, delete。一旦 Data App 被删除，Data App 中的现有端点和 API 密钥也将被删除。如果此 Data App 已连接到 GitHub，删除 App 不会删除相应 GitHub 仓库中的文件。