Skip to main content
我们经常发布文档更新，此页面的翻译可能仍在进行中。 有关最新信息，请访问英语文档。
All products
“应用”

创建 GitHub 应用程序

本文内容

你可以在你的个人帐户或你所属的任何组织下创建 GitHub App。

关于创建 GitHub Apps

你可以为你的个人帐户、你所属的组织或授权你管理其所有应用的组织创建 GitHub App。 有关详细信息，请参阅“为组织添加 GitHub 应用程序管理员”。

创建 GitHub App

  1. 导航到您的帐户设置。

    • 对于个人帐户拥有的 GitHub App，在任何页面的右上角，单击你的个人资料照片，然后单击“设置”。 用户栏中的 Settings 图标

    • 对于组织拥有的 GitHub App，在任何页面的右上角，单击你的个人资料照片，然后单击你的组织。 然后，在组织右侧，单击“设置”。

      @octocat 的个人资料图片下的下拉菜单的屏幕截图。 “你的组织”以深橙色标出。 设置按钮

  2. 在左侧边栏中，单击“ 开发人员设置”。

  3. 在左侧边栏中，单击“GitHub 应用”。 GitHub 应用部分

  4. 单击“新建 GitHub 应用”。

  5. 在“GitHub 应用名称”下，为应用输入名称。 你应选择一个易懂而简短的名称。应用执行操作时，应用的名称（转换为小写，且空格替换为 -，并替换特殊字符）将在用户界面中显示。 例如，My APp Näme 将显示为 my-app-name。

    该名称在 GitHub 中必须是唯一的。 所用名称不能与现有 GitHub 帐户同名，除非它是你自己的用户或组织的名称。

  6. （可选）在“描述”下，键入应用的描述。 用户和组织在安装你的应用时会看到此描述。

  7. 在“主页 URL”下，键入应用网站的完整 URL。 如果没有专用 URL，且应用代码存储在公共存储库中，则可以使用该存储库 URL。 或者，可以使用拥有该应用的组织或用户的 URL。

  8. （可选）在“回叫 URL”下，输入用户授权安装后要重定向到的完整 URL。

    可最多输入 10 个回叫 URL。 若要添加其他回叫 URL，请单击“添加回叫 URL”。

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

    有关回叫 URL 的详细信息，请参阅“关于用户授权回调 URL”。 有关生成用户访问令牌以代表用户执行操作的详细信息，请参阅“代表用户使用 GitHub 应用进行身份验证”和“为 GitHub 应用生成用户访问令牌”。

  9. （可选）若要防止用户访问令牌过期，请取消选择“使用户授权令牌过期”。 GitHub 强烈建议选择此选项。 有关刷新过期令牌和过期用户访问令牌的优势的详细信息，请参阅“刷新用户访问令牌”。 如果应用不需要生成用户访问令牌，则将忽略此字段。

  10. （可选）若要在用户安装应用时提示用户为其授权，请选择“安装时请求用户授权 (OAuth)”。 如果用户为应用授权，应用可以生成用户访问令牌，以代表用户发出 API 请求并将应用活动分配给用户。 有关详细信息，请参阅“代表用户使用 GitHub 应用进行身份验证”和“为 GitHub 应用生成用户访问令牌”。

  11. （可选）如果要使用设备流生成用户访问令牌，请选择“启用设备流”。 有关详细信息，请参阅“为 GitHub 应用生成用户访问令牌”。

  12. （可选）在“设置 URL”下，输入用户安装应用后重定向到的 URL。 如果安装后需要其他设置，可以使用此 URL 告知用户安装后要执行的步骤。

    如果在先前的步骤中选择了“安装时请求用户授权 (OAuth)”，你将无法在此处输入 URL。 用户将转而在授权流期间重定向到回叫 URL，你可在其中描述其他设置。

  13. （可选）如果要在用户更新安装后将其重定向到设置 URL，请选择“更新时重定向”。 更新包括添加或删除安装的存储库。 如果“设置 URL”为空，这将被忽略。

  14. （可选）如果不希望应用接收 webhook 事件，请取消选择“活动”。 例如，如果应用仅用于身份验证或不需要响应 webhook，请取消选择此选项。 有关详细信息，请参阅“将 Webhook 与 GitHub 应用配合使用”。

  15. 如果在上一步中选择了“活动”，则在“Webhook URL”下，输入 GitHub 应将 webhook 事件发送到的 URL。 有关详细信息，请参阅“将 Webhook 与 GitHub 应用配合使用”。

  16. （可选）如果在上一步中选择了“活动”，则在“Webhook 机密”下，输入用于保护 webhook 的机密令牌。 GitHub 强烈建议设置 webhook 机密。 有关详细信息，请参阅“将 Webhook 与 GitHub 应用配合使用”。

  17. 如果输入了 webhook URL，请在“SSL 验证”下选择是否启用 SSL 验证。 GitHub 强烈建议启用 SSL 验证。

  18. 在“权限”下，选择应用所需的权限。 对于每种权限，请选择下拉菜单，然后单击“只读”、“读写”或“无访问权限” 。 你应选择应用所需的最小权限。

  19. 如果在先前的步骤中选择了“活动”，表示应用应接收 webhook 事件，则请在“订阅事件”下选择希望应用接收的 webhook 事件。 在上一步中选择的权限决定哪些 Webhook 事件可用。 有关每个 webhook 事件的详细信息，请参阅“Webhook 事件和有效负载”。

  20. 在“此 GitHub 应用可以安装在哪些位置？”下，选择“仅在此帐户上”或“任何帐户” 。 有关安装选项的详细信息，请参阅“将 GitHub 应用程序设为公共或私有”。

  21. 单击“创建 GitHub 应用”。