npm 包 heroku-client 使用教程

简介

Heroku 是一个云平台，可以使用 JavaScript 客户端库 heroku-client 访问该平台的 API。该 npm 包提供与 Heroku Platform API 的交互，使开发人员可以编写自己的应用程序，并在 Heroku 上部署和管理应用程序。

安装

要开始使用 heroku-client，首先需要在项目中安装它。可以使用 npm 在命令行中运行以下命令：

npm install heroku-client

使用

以下是 heroku-client 常用的一些方法：

创建应用

const heroku = require('heroku-client');
const herokuClient = new heroku({ token: '<Heroku API Token>' });

herokuClient.post('/apps', { body: { name: 'my-new-app' } })
  .then(response => console.log(response))
  .catch(error => console.error(error));

删除应用

const heroku = require('heroku-client');
const herokuClient = new heroku({ token: '<Heroku API Token>' });

herokuClient.delete('/apps/:app_id_or_name')
  .then(response => console.log(response))
  .catch(error => console.error(error));

获取应用程序信息

const heroku = require('heroku-client');
const herokuClient = new heroku({ token: '<Heroku API Token>' });

herokuClient.get('/apps/:app_id_or_name')
  .then(response => console.log(response))
  .catch(error => console.error(error));

更改应用程序配置变量

const heroku = require('heroku-client');
const herokuClient = new heroku({ token: '<Heroku API Token>' });

herokuClient.patch(`/apps/:app_id_or_name/config-vars`, { body: { MY_CONFIG_VAR: 'my_value' } })
  .then(response => console.log(response))
  .catch(error => console.error(error));

获取应用程序日志

const heroku = require('heroku-client');
const herokuClient = new heroku({ token: '<Heroku API Token>' });

herokuClient.get('/apps/:app_id_or_name/logs')
  .then(response => console.log(response))
  .catch(error => console.error(error));

身份验证

访问 Heroku API 时需要身份验证。可以使用 API 密钥或 OAuth 令牌进行身份验证。

API 密钥

在 Heroku 的设置中，可以为帐户生成 API 密钥。可以使用此密钥进行身份验证。在创建 heroku-client 实例时，需要将 API 密钥包含在选项中：

const heroku = require('heroku-client');
const herokuClient = new heroku({ token: '<Heroku API Token>' });

OAuth 令牌

使用 OAuth 令牌进行身份验证需要进行额外的设置。可以通过 Heroku Dashboard 中的“API 密钥管理”选项卡来设置 OAuth 令牌。可以使用 OAuth 令牌进行身份验证：

-- -------------------- ---- -------
----- ------ - -------------------------
----- ------------ - --- ---------
----------------------
  -------- -
    --------- ----------------------------- -----------
    ---------------- ------- ----- ----- -------
  --
  ----- -----------------
  ----- --------
  ------- -----
---------------- -- -----------------------
展开代码

结论

heroku-client 是一个强大的 npm 包，允许开发人员使用 Heroku 平台 API 定制化和管理应用程序。在使用该包时，请始终遵循最佳实践，确保您的应用程序安全，保护您的 Heroku 帐户。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/109492