npm 包 @blinkmobile/evergreen-sdk 使用教程-JavaScript中文网-JavaScript教程资源分享门户

介绍

@blinkmobile/evergreen-sdk 是一款适用于前端的 npm 包，可以帮助开发者轻松实现与 Bluemix Evergreen 服务器通信的功能。Bluemix Evergreen 是 IBM 公司提供的一项云服务，用于为企业级应用程序提供 API 管理和自动化工具，以简化开发工作，并确保更快的时间到市场。

该 npm 包使用 TypeScript 编写，具有良好的可读性和可维护性。

安装

该包可以使用 npm 或 yarn 进行安装：

npm install @blinkmobile/evergreen-sdk

或

yarn add @blinkmobile/evergreen-sdk

快速入门

创建一个 Evergreen 实例

在你的代码中导入 Evergreen，然后创建一个实例。你需要提供你的 Evergreen API 端点 URL，作为创建实例的第一个参数。第二个参数为可选的，用于配置请求。

import { Evergreen } from "@blinkmobile/evergreen-sdk";

const client = new Evergreen("https://your-api-endpoint.com/", {
  headers: {
    Authorization: "Bearer YOUR_API_KEY"
  }
});

发送请求

可以在创建实例后，使用 client.get()、client.post()、client.put()、client.patch()、client.delete() 来调用 API。这些方法支持简易的 callback 风格或者是返回 promises。

// Callback 风格
client.get('/api/resource', (error, response) => {
  console.log(response.statusCode);
});

// Promise
await client.post('/api/resource', { message: 'Hello, Evergreen!' });

处理错误

如果请求失败，返回的错误将简单地包装在一个 EvergreenError 实例中，它扩展了 JavaScript 的原生 Error 对象。

-- -------------------- ---- -------
--- -
  ----- -------- - ----- ------------------------------------
- ----- ----- -
  -- ---- ---------- --------------- -
    ------------------------ --- ----- ------------------ -----------------
  - ---- -
    ---------------------------
  -
-

高级用法

配置多个请求

默认情况下，@blinkmobile/evergreen-sdk 使用 Node.js 的全局 http 和 https 模块来实现请求，这对于大多数用户来说是完全足够的。

但是，对于需要特定配置的用户（例如通过代理连接到 Evergreen、需要 SSL 证书身份验证等等），可以使用自定义的 http 和 https 实例将其传递给 Evergreen 构造函数的第三个参数中。

-- -------------------- ---- -------
------ - --------- - ---- -----------------------------
------ ---- ---- -------
------ ----- ---- --------

----- ------ - --- ------------------------------------------- -
  -------- -
    -------------- ------- -------------
  -
-- -
  ----- -----
  ------ -----
---

处理自定义 HTTP 错误

Evergreen 在响应的 HTTP 头部中会包含自定义错误代码。如果你需要对这些代码做特殊处理，可以在请求后的 Promise 或者 callback 中处理。

-- -------------------- ---- -------
--------------------------- ----- ---- -- -
  -- ----- -
    -- --------------- --- ---- -
      ----------------------- --- --------
    - ---- -- --------------- --- ---- -
      --------------------------- -- ------ -----------
    - ---- -
      ---------------------- ------ -----------------------
    -
  - ---- -
    -----------------------
  -
---

自定义认证

默认情况下，Evergreen 使用 OAuth2 JWT 令牌进行身份验证，如果需要，也可以将自己的认证方式提供给 Evergreen 构造函数的第二个参数上的 headers 对象中。

import { Evergreen } from "@blinkmobile/evergreen-sdk";

const client = new Evergreen("https://your-api-endpoint.com/", {
  headers: {
    "X-My-Custom-Auth": "token value here"
  }
});

结论

@blinkmobile/evergreen-sdk 是一款非常方便的 npm 包，可用于帮助开发者轻松实现与 Bluemix Evergreen 服务器通信的功能。它易于使用，易于阅读和维护，具有灵活的配置和自定义选项。因此，我们鼓励开发者尝试使用该库来加速他们的 Bluemix Evergreen 开发过程。

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

npm 包 @blinkmobile/evergreen-sdk 使用教程

介绍

安装