注册 GitHub 应用程序

您可以在您的个人帐户下或您拥有的任何组织下注册 GitHub 应用程序。

本文内容

关于注册 GitHub 应用程序

您可以通过几种不同的方式注册 GitHub 应用程序。

在您的**个人帐户**下。
在您**拥有的组织**下。
在已授予您管理其所有应用的权限的**组织**下。请参阅“在您的组织中添加和删除 GitHub 应用管理员”。

用户或组织最多可以注册 100 个 GitHub 应用，但帐户上可以安装的 GitHub 应用数量没有限制。

注册 GitHub 应用

在 GitHub 上任何页面右上角，点击您的个人资料照片。
导航到您的帐户设置。
- 对于个人帐户拥有的应用，点击**设置**。
- 对于组织拥有的应用
  1. 点击**您的组织**。
  2. 在组织的右侧，点击**设置**。
在左侧边栏中，点击** 开发者设置**。
在左侧边栏中，点击**GitHub 应用**。
点击**新建 GitHub 应用**。
在“GitHub 应用名称”下，输入应用的名称。您应该选择一个清晰简短的名称。名称长度不能超过 34 个字符。当您的应用执行操作时，您的应用名称（转换为小写，空格替换为-，特殊字符替换）将显示在用户界面中。例如，My APp Näme 将显示为my-app-name。

名称在整个 GitHub 中必须唯一。您不能使用与现有 GitHub 帐户相同的名称，除非它是您自己的用户或组织名称。
可选地，在“描述”下，键入应用的描述。用户和组织在安装您的应用时将看到此描述。
在“主页 URL”下，键入应用网站的完整 URL。如果您没有专用的 URL，并且您的应用代码存储在公共存储库中，则可以使用该存储库 URL。或者，您可以使用拥有该应用的组织或用户的 URL。
可选地，在“回调 URL”下，输入在用户授权安装后重定向到的完整 URL。

您可以输入最多 10 个回调 URL。要添加其他回调 URL，请点击**添加回调 URL**。

如果您的应用不需要代表用户执行操作（不需要生成用户访问令牌），则此字段将被忽略。如果您的应用使用设备流而不是 Web 应用程序流来生成用户访问令牌，则此字段将被忽略。

有关回调 URL 的更多信息，请参阅“关于用户授权回调 URL”。有关生成用户访问令牌以代表用户执行操作的更多信息，请参阅“代表用户使用 GitHub 应用进行身份验证”和“为 GitHub 应用生成用户访问令牌”。
可选地，要防止用户访问令牌过期，请取消选择**用户授权令牌过期**。GitHub 强烈建议您保持此选项处于选中状态。有关刷新过期令牌以及过期用户访问令牌的好处的更多信息，请参阅“刷新用户访问令牌”。如果您的应用不需要生成用户访问令牌，则此字段将被忽略。
可选地，要提示用户在安装您的应用时授权，请选择**在安装期间请求用户授权（OAuth）**。如果用户授权您的应用，则您的应用可以生成用户访问令牌以代表用户发出 API 请求并将应用活动归因于用户。有关更多信息，请参阅“代表用户使用 GitHub 应用进行身份验证”和“为 GitHub 应用生成用户访问令牌”。
可选地，如果您要使用设备流来生成用户访问令牌，请选择**启用设备流**。有关更多信息，请参阅“为 GitHub 应用生成用户访问令牌”。
可选地，在“设置 URL”下，输入在用户安装您的应用后重定向到的 URL。如果安装后需要其他设置，则可以使用此 URL 告诉用户安装后需要执行哪些步骤。有关更多信息，请参阅“关于设置 URL”。

如果您在前面的步骤中选择了**在安装期间请求用户授权（OAuth）**，则将无法在此处输入 URL。取而代之的是，用户将在授权流程的一部分中重定向到回调 URL，您可以在其中描述其他设置。
可选地，如果您希望在用户更新安装后重定向到设置 URL，请选择**更新时重定向**。更新包括为安装添加或删除存储库。如果“设置 URL”为空，则此选项将被忽略。
可选地，如果您不希望您的应用接收 Webhook 事件，请取消选择**活动**。例如，如果您的应用仅用于身份验证或不需要响应 Webhook，请取消选择此选项。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。
如果您在前面的步骤中选择了**活动**，则在“Webhook URL”下，输入 GitHub 应将 Webhook 事件发送到的 URL。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。
可选地，如果您在前面的步骤中选择了**活动**，则在“Webhook 密钥”下，输入一个密钥令牌来保护您的 Webhook。GitHub 强烈建议您设置一个 Webhook 密钥。有关更多信息，请参阅“将 Webhook 与 GitHub 应用一起使用”。
如果您输入了 Webhook URL，则在“SSL 验证”下，选择是否启用 SSL 验证。GitHub 强烈建议您启用 SSL 验证。
在“权限”下，选择您的应用所需的权限。对于每个权限，选择下拉菜单并点击**只读**、**读写**或**无访问权限**。您应该选择应用所需的最低权限。有关更多信息，请参阅“为 GitHub 应用选择权限”。
如果您在前面的步骤中选择了**活动**以指示您的应用应该接收 Webhook 事件，则在“订阅事件”下，选择您希望您的应用接收的 Webhook 事件。您在前面步骤中选择的权限决定了哪些 Webhook 事件可用。有关每个 Webhook 事件的更多信息，请参阅“Webhook 事件和有效负载”。
在“此 GitHub 应用可以在哪里安装？”下，选择**仅在此帐户上**或**任何帐户**。有关安装选项的更多信息，请参阅“使 GitHub 应用公开或私有”。
点击**创建 GitHub 应用**。

后续步骤

注册 GitHub 应用后，您需要编写代码才能使您的 GitHub 应用执行某些操作。有关如何编写代码的示例，请参阅

您应该努力遵循最佳实践。有关更多信息，请参阅“创建 GitHub 应用的最佳实践”。

完全构建 GitHub 应用后，您可以安装您的 GitHub 应用并与其他人共享您的 GitHub 应用。有关更多信息，请参阅“安装您自己的 GitHub 应用”和“共享您的 GitHub 应用”。

您可以随时更改 GitHub 应用的设置。有关更多信息，请参阅“修改 GitHub 应用注册”。