npm 包 generator-appdirect-connector 使用教程

前言

generator-appdirect-connector 是一个基于 Yeoman 的脚手架工具，用于快速创建 AppDirect Connector 项目框架。AppDirect Connector 是连接 AppDirect Marketplace 和你的应用程序的途径，该 npm 包在创建一个 Connector 项目时，会自动生成符合 AppDirect Connector 规范的代码结构与文件，帮助你快速完成 Connector 开发。

安装

在安装 generator-appdirect-connector 之前，首先需要安装 Node.js 与 npm。然后在命令行工具中输入以下命令安装 generator-appdirect-connector：

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

安装完成后，通过以下命令来验证是否安装成功：

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

如果安装成功，会出现以下的提示信息：

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

使用

运行以下命令来创建一个新的 AppDirect Connector 项目：

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

之后，你将会进入一个交互式的命令行界面，在其中你将需要输入一些基本的项目配置信息，例如 Connector 名称、作者、版权信息等。在输入完所有信息后，你将会看到一个新的 AppDirect Connector 项目已经生成，并包含一些基本的代码结构。以下是创建的项目的代码结构：

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

在以下部分中，我们将会解释该项目的重要代码部分。

app.js

该文件是整个应用程序的入口文件。通过该文件，你可以了解应用程序定义了哪些路由规则，以及如何习惯性地处理到来的 HTTP 请求。在一个 Connector 项目中，应该将请求转发到具体的 Controller 中，而 Controller 的作用是处理并响应来自 AppDirect Marketplace 的事件。

lib/server.js

该文件包含了实现 Controller 的处理器的代码。在 Connector 中，Controller 主要处理 AppDirect Marketplace 发送的事件。使用此文件，你可以创建跟 AppDirect Marketplace 的连接，以接收 AppDirect Marketplace 发送的事件信息并解析。在处理完事件后，Controller 会根据需要采取相应的行动或响应。

public/assets

该文件夹用于存放与该 Connector 相关的文件。在该文件夹中，你可以存入该 Connector 的图标、图片等内容。

public/scripts

在该文件夹中，你可以存储 JavaScript 脚本文件，以在应用程序中使用这些脚本。

public/styles

该文件夹在 Connector 中主要用于存储与CSS相关的文件。在该文件夹中，你可以编写需要应用于该 Connector 界面的 CSS 文件。

views

在该文件夹中，你可以存放用于渲染 Connector 界面的 HTML 文件。该文件夹中的所有HTML文件都可以通过Handlebars.js进行渲染。

test/server.js

该文件包含要运行的测试代码，用于核实 Controller 函数是否能够正常接收 AppDirect Marketplace 发送的事件并正常处理此事件。

示例代码

在此处，我们将提供一些示例代码，以帮助你快速了解如何使用 generator-appdirect-connector 。

在整个示例代码中，$Connector 代表您的 Connector 名称。

创建本地 AppDirect Connector 项目

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

提示输入 Connector 的名称、作者、版权信息等基本信息，之后会自动生成一个基本的 Connector 项目。

启动本地 Connector 应用程序

进入新建项目的根目录，在命令行中输入以下命令启动应用程序：

--- -----

连接到 AppDirect Marketplace

要连接到 AppDirect Marketplace，你需要创建一个向 AppDirect Marketplace 注册你的 Connector 的 URL，即您将启动本地应用程序的域名。例如，如果本地应用程序使用的域名为$Connector.local，那么该 URL 会是：

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

所生成的项目包含一个名为 lib/server.js 的文件，此文件可用于创建一个连接到 AppDirect Marketplace 的代码。使用以下代码：

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

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

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

当应用程序启动并侦听连接时，它将自动连接到 AppDirect Marketplace 并尝试向 AppDirect 注册 Connector。当成功注册连接器时，您将看到如下输出：

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

这样，你就成功的连接到了 AppDirect Marketplace，并且向其注册了 Connector 信息。

使用 Controller 处理来自 AppDirect 的事件

在本例中，我们将展示如何编写一个特定的 Controller，该 Controller 处理用户订阅AppDirect的事件。我们将使用一个名为 subscription_create 的应用程序路由，并使用与其关联的 Controller 处理它。

在 app.js 中，添加以下代码：

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

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

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

在 lib/server.js 中，你可以在Controller中添加如下代码：

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

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

在此处，我们添加了一个名为 createSubscription 的函数，该函数用于处理 SUBSCRIPTION_ORDER 事件（即用户购买该应用程序的订阅）。

可使用 validateRequest 函数来验证 AppDirect 的发送操作是否确定：

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

在上述代码中，我们使用标准 Node.js 加密库来验证 AppDirect 的事件 URL，以确保请求确实是由 AppDirect Marketplace 发送的。

结论

generator-appdirect-connector 是一个使您更快更轻松地建立 AppDirect 接口通信的强大工具。如果你觉得在之前的上下文中缺少重要部分或是存在问题，欢迎在下面的评论中反馈。 通过使用此工具，您将能够更轻松地连接到 AppDirect Marketplace，并更快地完成 Connector 项目的开发。

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

阅读全文

猜你喜欢

  • npm 包 @tlslaj0417/theme 使用教程

    前言 在前端开发中，我们经常需要对页面进行样式的定制化，但如果每次都手写 CSS 样式，会非常耗时。因此，很多前端工程师会选择使用第三方的 CSS 框架，例如 Bootstrap、Ant Design...

    3 年前
  • npm 包 @yuanjunliang/bottos-crypto-js 使用教程

    引言 随着区块链技术的发展，无论是在加密货币行业还是在其他应用领域，使用密码学技术进行安全通信和数据存储变得越来越重要。@yuanjunliang/bottos-crypto-js 是一个可以帮助您进...

    3 年前
  • npm 包 magento-checkout 使用教程

    Magento 是一款功能强大的电子商务平台，而 magento-checkout 是一个方便的 npm 包，可以帮助开发人员快速集成 Magento 的结账流程。

    3 年前
  • npm 包 tlslaj0417 使用教程

    随着互联网的不断发展，前端技术变得越来越重要。npm 作为 Node.js 的包管理器，方便了前端开发者的使用。而 tlslaj0417 是一个前端开发者必备的 npm 包，本篇文章将深入介绍如何使用...

    3 年前
  • npm 包 @launch/styles 使用教程

    背景 在前端开发中，我们常常需要引入 CSS 样式，以美化网站或应用的外观。通常来说，我们可以手写 CSS 文件，也可以使用预处理工具如 LESS 和 SASS 来编写样式。

    3 年前
  • npm 包 stackoverflow-api 使用教程

    简介 stackoverflow-api 是一个 npm 包，它提供了与 Stack Overflow API 进行交互的功能。使用 stackoverflow-api，你可以轻松地从 Stack O...

    3 年前
  • npm 包 @appsflare/quill-image-resize-module 使用教程

    前言 随着前端技术的快速发展，富文本编辑器的使用也越来越普遍。其中，Quill 是一款非常优秀的富文本编辑器，它提供了许多功能强大的插件，让开发者可以更轻松地实现自己的需求。

    3 年前
  • npm 包 react-native-my-custom-lib-videocall 使用教程

    简介 react-native-my-custom-lib-videocall 是一个基于 React Native 的自定义 JavaScript 库，可以轻松实现视频通话功能。

    3 年前
  • npm 包 tnb 使用教程

    什么是 tnb？ tnb 是一种可用于前端项目的组件化开发框架，它提供了许多工具和资源，使得开发人员能够更加轻松地开发出高质量的前端应用程序。 如何安装 tnb？ 你可以使用 npm 命令来安装 tn...

    3 年前
  • npm包 @robotkittens/cookie-universal 使用教程

    在现代web应用程序中，对于用户的状态和偏好设置以及与服务器之间的身份验证，cookie是一种不可或缺的工具。而随着前端应用程序变得越来越复杂，处理cookie也变得越来越复杂。

    3 年前
  • npm 包 @robotkittens/cookie-universal-nuxt 使用教程

    前言 在前端开发中，cookie 是一个重要的概念。它可以在客户端存储一些用户数据，比如说登录状态、购物车信息等等。cookie 也可以被用于用户行为分析及广告投放等方面。

    3 年前
  • npm 包 pentabarf 使用教程

    Pentabarf 是一款基于 Node.js 的 npm 包，用于处理社交媒体活动中的时光表。它提供了一组实用的工具，以方便地获取、解析和操作时光表数据。本文将会为大家介绍 Pentabarf 包的...

    3 年前
  • npm 包 mysql_basic 使用教程

    简介 mysql_basic 是一个 npm 包，提供了基础的 MySQL 数据库连接和操作功能，帮助前端开发者快速接入 MySQL 数据库，实现数据的存储和查询。

    3 年前
  • npm 包 e-substring 使用教程

    当我们需要处理字符串时，JavaScript 提供了一些内置的方法，如 slice() 和 substring()。但是，这些方法在处理 Unicode 字符串时会变得棘手。

    3 年前
  • npm 包 lol-champs 使用教程

    简介 lol-champs 是一个可在前端使用的 npm 包，它提供了 League of Legends（LOL）游戏中所有英雄的相关信息，例如英雄名、英雄头像、英雄技能等。

    3 年前
  • npm 包 nampg123 使用教程

    什么是 nampg123 nampg123 是一个使用 JavaScript 封装 libmpg123 库的 npm 包，用于在 Node.js 环境下解码 MP3 音频文件。

    3 年前
  • NPM 包 Redux-Connect-New 使用教程

    Redux-Connect-New 是一个使用 React 和 Redux 技术栈编写的前端应用程序的高阶组件。它可以实现连接 React 组件和 Redux Store 的功能，使得应用程序的状态管...

    3 年前
  • npm包 @speedy/node-core 使用教程

    简介 @speedy/node-core是一个专门为Node.js开发者打造的npm包，它提供了一系列强大的工具，可以帮助开发者更快速，更高效地构建Node.js应用程序。

    3 年前
  • npm 包 e-ngx-calendar 使用教程

    本文将介绍如何使用 npm 包 e-ngx-calendar，该包是一个基于 Angular 的日历组件，具有丰富的功能和定制性。 安装 首先需要安装 npm，然后在项目目录下执行以下命令安装 e-n...

    3 年前
  • npm包 Ember-defer的使用教程

    在现代的前端开发中，我们经常需要处理异步操作，如ajax请求、定时器等。有时候，我们需要将这些异步操作包裹在一个Promise或者Deferred中方便后续处理。Ember-defer是一个可以帮助我...

    3 年前

相关推荐

    暂无文章