在为 App 编写代码之前,应先注册一个 App。 注册 App 时,可以选择该应用的权限。 这些权限决定了 App 可以执行的操作。 注册应用时,还可以指定其他设置,包括 App 应接收哪些 Webhook 事件。 始终可以更改 App 注册的设置。 有关详细信息,请参阅 注册 应用 和 修改 应用注册。
如果希望 App 访问存储库和/或组织数据,则需要安装 App。 有关详细信息,请参阅“安装自己的 应用”。
为了使 App 能够执行某些操作,你需要编写代码以向 App 添加功能。
有关如何为 App 编写代码的教程,请参阅:
可以使用 App 注册中的凭据向 的 API 发出经过身份验证的请求。 有关详细信息,请参阅“关于使用 应用进行身份验证”。
在开发过程中,你很可能会使用个人计算机或 codespace 来运行 App。 在开发过程中,可能需要对 App 注册进行一些修改:
如果你的应用收到 Webhook,你可能希望使用 Webhook 代理 URL 将 Webhook 从 转发到计算机或 codespace。 你需要更新 App 注册中的“Webhook URL”设置才能使用 Webhook 代理 URL。 有关示例,请参阅“构建响应 Webhook 事件的 应用”。
如果你的应用使用 Web 应用程序流来授权用户,你可能希望更新 App 注册中的“回叫 URL”设置,以使用本地回叫 URL。 有关示例,请参阅“使用 Apps 生成“使用 登录”按钮”。
为 App 编写代码后,应确保它遵循最佳做法。 如有必要,请记得更新 App 注册。 如果你的 App 需要在服务器而不是用户设备上运行,请将你的应用部署到服务器。 最后,可以与其他用户和组织共享自己的 App。
在部署 App 之前,请确保遵循最佳做法。 例如,请确保 App 的凭据是安全的。 有关详细信息,请参阅“创建 应用的最佳做法”。
如果更改了用于开发的 App 注册,请确保更新该注册以使用生产就绪值。 例如,如果使用 Webhook 代理 URL 进行开发,则应更新“Webhook URL”字段,以使用希望 App 在生产期间接收 Webhook 的 URL。
为 App 编写代码后,需要在某个位置运行代码。 如果你的应用是网站或 Web 应用,则可以将应用托管在服务器(如 Azure 应用服务)上。 如果你的应用是客户端应用,它可能会在用户的设备上运行。
如果要与其他用户和组织共享 App,则应公开你的 App。 有关详细信息,请参阅“共享 应用”。