npm 包 swint-akamai-purge 使用教程

阅读时长 4 分钟读完

在前端开发中,常常会使用到 CDN 来加速静态资源的访问速度。使用 CDN 带来了很多优点,但也带来了一些问题。比如,当静态资源发生更新时,需要将更新的资源通知 CDN,才能让用户重新获取最新更新的资源。这个过程需要使用到 CDN 提供的刷新 API 接口。

AKAMAI 是一家国际 CDN 服务提供商,其提供了非常好用的刷新 API 接口。为了方便开发者调用这些接口,我们可以使用 npm 包 swint-akamai-purge。本文将详细介绍这个 npm 包的使用方法,对于使用 AKAMAI CDN 的开发者非常有参考价值。

安装 swint-akamai-purge

在使用 swint-akamai-purge 包之前,我们需要先进行安装。使用以下命令即可完成安装:

初始化 swint-akamai-purge

安装了 swint-akamai-purge 包之后,我们需要对其进行初始化,才能调用 AKAMAI 刷新 API 接口。在使用前需要在 ./swint-akamai-purge.config.coffee 填写你的 AKAMAI 认证信息:

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

其中 paths 数组存放了需要刷新的资源路径。路径可以包含通配符(例如,http://assets.example.com/*.js)。akamaiConfig 对象包含了 AKAMAI 认证信息。其中,username 和 password 分别存放 AKAMAI 用户名和密码,email 存放远程缓存请求的电子邮件地址,network 是 AKAMAI 网络类型,urls 数组列出了 AKAMAI API 使用的 URL。

swint-akamai-purge 包使用 CoffeeScript 编写,因此,上述 AKAMAI 认证信息需要使用 CoffeeScript 的语法进行编写。

使用 swint-akamai-purge

swint-akamai-purge 的使用非常简单,主要包括两个命令。第一个命令是用来调用 AKAMAI 刷新 API 接口的,可以在终端中运行以下命令:

其中,your_network 是 AKAMAI 网络类型,your_cpcode 是需要刷新的资源路径。

第二个命令是用来查看当前 AKAMAI 刷新 API 接口调用的状态,可以在终端中运行以下命令:

其中,your_jobid 是调用 AKAMAI 刷新 API 接口时返回的 jobid。

示例代码

以下示例代码展示了如何在 Node.js 中使用 swint-akamai-purge 调用 AKAMAI 刷新 API 接口。

在这个示例代码中,我们首先导入 swint-akamai-purge 包,然后使用 require 引入配置文件。调用 swintAkamaiPurge 函数来提交刷新请求,该函数将返回刷新请求的 jobid。最后,在回调函数中输出 jobid。

总结

本文介绍了如何使用 npm 包 swint-akamai-purge 来调用 AKAMAI 的刷新 API 接口。鉴于 AKAMAI 是全球著名的 CDN 服务提供商之一,使用 swint-akamai-purge 对于 CDN 开发者来说非常有参考价值。同时,本文还提供了详细的示例代码,方便读者更好地理解使用流程。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/73214

纠错
反馈