npm 包 is-valid-github-event 使用教程

在前端开发领域中，开发者经常需要跟 Github 交互。如果您正在为 Github 开发应用程序或自动化脚本，那么您需要一种方法来验证 Github 事件是否合法。is-valid-github-event 是一个 NPM 包，允许您验证 Github 的事件，并确保它们来自合法的来源。

什么是 Github 事件

Github 事件是 Github 发出的 Webhook 服务器发送给您提供的 URL 的 HTTP POST 请求，用于通知您发生的事件。对于每种事件类型，Github 都会尝试发送相应的 JSON 负载。对于一个简单的 push 事件，负载可能如下所示：

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

npm 包 is-valid-github-event 的作用

从上面的负载中可以看到，有许多不同的消息类型。每种消息类型需要不同的验证方式。is-valid-github-event 包封装了验证 Github 事件的过程。

具体来说，is-valid-github-event 允许您：

  1. 验证传入的 json 数据是一个已知的 Github 事件类型
  2. 验证事件签名，以确保 Github 事件确实来自于 Github，并且未被篡改

npm 包 is-valid-github-event 的使用

下面我们来详细介绍 npm 包 is-valid-github-event 的使用方法。

1. 安装 is-valid-github-event

首先，您需要将 is-valid-github-event 安装到您的项目中，您可以通过在终端中输入以下命令来完成安装：

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

2. 引入 is-valid-github-event

在您的代码中引入 is-valid-github-event 包：

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

3. 验证 Github 事件

现在我们来编写一个代码片段，用于验证 Github 事件：

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

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

在该代码中，我们重点描述了如下四个计算机参数：

  1. event：Github 事件的名称；
  2. payload：Github 事件携带的负载数据；
  3. signature：Github 对事件签名的 hmac；
  4. secret：您在 Github 中为挂载点设置的 webhook 密钥。

如果验证成功，isValidGithubEvent 函数将返回 true，否则将返回 false。

示例代码

在这里，我们提供了一个完整的代码示例，以更好地展示如何在您自己的代码中使用 is-valid-github-event 包：

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

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

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

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

在实际代码中，您可以根据需要更改 secret、port 或任何其他变量。

结论

通过本文，您现在已经知道 is-valid-github-event 的 npm 包是如何工作的，以及如何验证来自 Github 的事件。这个包的用途很广泛，您可以在自己的应用程序或自动化脚本中使用它，以确保 Github 事件的有效性。如果您想知道更多有关该包的信息，请查看官方文档（https://github.com/nlf/is-valid-github-event ）。

来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/600559e681e8991b448d78a5

阅读全文

猜你喜欢

  • npm 包 file-button-react 使用教程

    介绍 npm 包 file-button-react 是一个 React 组件，它提供了一个文件选择器的按钮。使用此组件可以轻松地实现文件上传功能。 该组件支持自定义样式、文本和上传方法。

    2 年前
  • npm 包 imodule 使用教程

    介绍 imodule 是一个在前端开发中常用的 npm 包，它可以让我们方便地在代码中使用模块化的方法。本文将详细介绍 imodule 的使用方法，帮助读者更好地掌握这个非常有用的工具。

    2 年前
  • NPM 包 graphql-tools-bchen 使用教程

    什么是 graphql-tools-bchen？ GraphQL-Tools-bchen 是一款基于 GraphQL 的工具包，能够简化开发过程，提高开发效率。该工具包包含一些列重要的 API，能够轻...

    2 年前
  • NPM包optical-kerning使用教程

    简介 Optical-kerning是一个专门为网页设计师和前端开发人员设计的一个 JavaScript 库，它用于实现更好的字体对齐效果。在使用 optical-kerning 之后，文字的间距将会...

    2 年前
  • npm 包 slider-index 使用教程

    slider-index 是一个基于 JavaScript 的 npm 包，用于帮助 web 开发者快速创建幻灯片效果的轮播组件。它提供了丰富的配置项，使得轮播组件功能更加强大，使用更加灵活。

    2 年前
  • npm 包 tizen-sdb 使用教程

    简介 tizen-sdb 是面向 Samsung Tizen 平台的一款基于 Node.js 的 CLI 工具，通过该工具可以在电脑上进行 Tizen 设备的调试和管理工作。

    2 年前
  • npm 包 yake 使用教程

    前言 近年来，随着技术的飞速发展和应用需求的不断增加，一些流程、构建和自动化工具逐渐在前端领域中得到了广泛的应用。yake 就是一款基于 Node.js 的自动化构建工具，它可以让前端开发者更方便地进...

    2 年前
  • npm 包 flexi-layouts 使用教程

    简介 flexi-layouts 是一款轻量级的 npm 包，旨在为前端开发者提供一个灵活、简便的方法来创建各种布局。它基于 flexbox 布局，能够帮助开发者快速创建现代化的响应式页面。

    2 年前
  • NPM 包 tdaa-ui 使用教程

    前言 tdaa-ui 是一款基于 React 的 UI 组件库，提供了丰富的组件和样式库，适用于开发各种 Web 应用。本篇文章将介绍如何在自己的项目中使用 tdaa-ui 包，包括安装、使用方法和示...

    2 年前
  • NPM 包 Snape-config 的使用教程

    介绍 Snape-config 是一个基于 Node.js 平台的 npm 包，它能够帮助前端开发者更方便地管理项目的配置。 Snape-config 提供了一套易用的 API，可以实现以下功能： ...

    2 年前
  • npm 包 1tree-json 使用教程

    开发过程中，我们经常需要处理 JSON 数据，尤其是前端开发。在这个过程中，1tree-json 这个 npm 包能够为我们提供极大的便捷和效率。本文将带领大家了解 1tree-json 的使用方法和...

    2 年前
  • npm包 1tree-schema使用教程

    前言 1tree-schema是一个基于JavaScript的npm包，用于生成数据模型和模式验证。本文将介绍1tree-schema的功能和使用方式，以及如何在前端开发中使用它。

    2 年前
  • npm 包 @endeo/decoder 使用教程

    在前端开发中，数据的解析和处理是非常重要的一环。@endeo/decoder 这个 npm 包提供了简单易用且高效的解码器，支持多种数据格式的解码和处理，包括 JSON、XML 和二进制流。

    2 年前
  • npm 包 @hnct/uicommon 使用教程

    在前端开发中，我们经常需要使用一些 UI 组件来实现网页的交互效果。使用 UI 组件可以使我们的开发效率更高，同时也可以提升用户体验。在这个过程中，我们会使用很多第三方库和工具来帮助我们完成开发。

    2 年前
  • npm 包@nfcampos/react-native-blur 使用教程

    1.介绍 @nfcampos/react-native-blur 是一个基于 React Native 的模糊效果组件库。它支持在 iOS 和 Android 平台上，使用高效的 GPU 模糊方式渲染...

    2 年前
  • npm 包 @mojule/events 使用教程

    什么是 @mojule/events？ @mojule/events 是一款用于事件分发和监听的 JavaScript 库，它可以帮助前端开发者快速构建响应式的前端应用程序。

    2 年前
  • npm 包 @nfcampos/react-native-htmlview 使用教程

    前言 在 React Native 开发中，我们时常需要展示 HTML 内容。而 @nfcampos/react-native-htmlview 是一个非常实用的 npm 包，可以将 HTML 转换为...

    2 年前
  • npm 包 enbyte 使用教程

    在前端开发中，我们常常需要在不同的数据传输渠道中进行数据的转换，特别是当我们需要从二进制数据中获取信息或将信息转换为二进制数据时。enbyte 是一个 npm 包，它提供了一个便捷的方法来进行字符串和...

    2 年前
  • npm 包 generator-webpack-2-es-6 使用教程

    1. 简介 generator-webpack-2-es-6 是一个用于生成基于 webpack 2 和 ES6 构建的前端项目的 npm 包。它可以帮助开发者快速搭建一个基于 webpack 2 和...

    2 年前
  • NPM包mojule-transform使用教程

    简述 mojule-transform是一个npm包，提供了一种将模型数据转换为其他格式的工具。它是一种基于扩展现有数据模型的方法，通过将模型中的数据映射到新的格式，使得数据相对应。

    2 年前

相关推荐

    暂无文章