将 Node.js 添加到现有 API 代理

您正在查看的是 Apigee Edge 文档。
转到 Apigee X 文档
信息

简介

本主题介绍如何将 Node.js 应用添加到本地文件系统上的现有代理,以及如何将该代理部署到 Apigee Edge。

准备开发环境

在本主题中,我们假设您已经在本地系统上设置了代理开发环境,并且想要在其中集成 Node.js 应用。

包含 Node.js 应用的代理应用的基本结构遵循下图所示的模式,具有一个基本 /apiproxy 文件夹以及对应于资源目标代理的子文件夹。apiproxy/resources/node 文件夹是必须放置 Node.js 文件的位置。其他文件夹包含用于定义代理和目标端点、代理流程、条件流程等的 XML 文件。如需了解 API 代理结构的更完整说明,请参阅 API 代理配置参考文档

请注意,代理的任何 Node.js 代码都必须放置在 /apiproxy/resources/node 下。这是 Edge 希望在部署后找到它的位置。

使用 ScriptTarget 指定 Node.js 目标

如需将 Node.js 集成到代理中,关键是在目标端点的 XML 文件中指定 <ScriptTarget> 元素。在代理文件结构中,此 XML 文件位于 apiproxy/targets。默认情况下,文件名为 default.xml

考虑到上下文,假设目标端点通常指向某种后端服务。在本例中,我们使用了 Apigee 模拟目标服务。目标端点定义如下所示:

<TargetEndpoint name="default">
    <Description/>
    <Flows/>
    <PreFlow name="PreFlow">
        <Request/>
        <Response/>
    </PreFlow>
    <HTTPTargetConnection>
        <URL>http://mocktarget.apigee.net/</URL>
    </HTTPTargetConnection>
    <PostFlow name="PostFlow">
        <Request/>
        <Response/>
    </PostFlow>
</TargetEndpoint>

<HTTPTargetConnection> 元素指定后端服务(Apigee 模拟目标服务)的网址。

但对于 Node.js,Node.js 应用 本身 目标。您可以使用 apiproxy/targets/default.xml 文件中的 <ScriptTarget> 指定此目录。

与使用 <HTTPTargetConnection> 元素指定后端服务网址的目标不同,使用 <ScriptTarget> 元素直接引用 Node.js 应用,如下所示:

<TargetEndpoint name="default">
    <ScriptTarget>
         <ResourceURL>node://server.js</ResourceURL>
    </ScriptTarget>
    <PreFlow name="PreFlow">
        <Request/>
        <Response/>
    </PreFlow>
</TargetEndpoint>

<Resource网址> 参数必须始终以 node:// 为前缀,后跟 Node.js 主脚本的名称。此外,如前所述,Node.js 资源必须位于 API 代理范围内的 /apiproxy/resources/node 中。

您可以在 ScriptTarget 中设置其他参数。如需了解详情,请参阅 高级 ScriptTarget 配置

在本示例中,以下是主要 Node.js 文件(名为 server.js)的源代码。它是在收到请求时会返回“Hello World!”的基本 HTTP 服务器:

var http = require('http');
console.log('node.js application starting...');
var svr = http.createServer(function(req, resp) {
    resp.end('Hello, Node!');
});

svr.listen(process.env.PORT || 9000, function() {
    console.log('Node HTTP server is listening');
});

总而言之,假设主 Node.js 应用是在名为 server.js 的文件中实现,并且端点配置都命名为 default.xml,那么包含 Node.js 脚本的 API 代理将具有以下结构:

/apiproxy/proxyName.xml
/apiproxy/proxies/default.xml
/apiproxy/targets/default.xml
/apiproxy/resources/node/server.js

准备部署应用

大多数 Node.js 应用都有依赖项文件,并在基本目录中包含 package.json 文件。在这种情况下,最佳做法是运行 npm 实用程序,以确保在部署之前使用依赖项填充顶级 node_modules 目录。如果存在任何未包含在 node_modules 中的远程依赖项,则 Node.js 应用将不会在 Edge 上运行。

您可以使用 npm 实用程序轻松将所有依赖项检索到文件系统:

  1. 从 Node.js 应用的基本目录中,运行以下命令:
$ npm install 

$ npm update

安装依赖项后,您就可以将代理部署到 Edge。

将 Node.js 应用部署到 Apigee Edge

在部署之前,您需要知道 Apigee Edge 帐号的组织名称、用户名和密码。您需要此信息才能正确生成部署工具命令。

命令如下。它假定您(通过 -d 标志)位于代理的根目录中。如果您的代理名为 foo,请从 foo 目录输入以下命令:

$ apigeetool deployproxy -u username -p password -o org -e test -n hellonode -d .
如需了解每个命令标志的含义,请执行以下操作:

$ apigeetool deployproxy -h

简明摘要:

  • -n:借助此标志,您可以指定在部署应用时创建的代理的名称。您将在管理界面中看到此名称。
  • -d 指定 API 代理的根目录。
  • -o-e-u-p 指定组织名称、部署环境、用户名和密码。
大功告成。您的 Node.js 应用封装在 API 代理中,部署到 Edge,并执行。它正在等待请求,随时可供测试。

测试新的 API 代理

您刚刚将 Node.js 应用添加到了现有 API 代理,并将该代理部署到了 Apigee Edge!如需对其进行测试,请运行此 c网址 命令。我们假定使用的是默认基本路径 (/)(基准路径在代理端点配置文件中指定)。请务必将 org_name 替换为您的组织名称。如果您未安装 c网址,可以在浏览器中输入网址。

$ curl http://org_name-test.apigee.net/
Hello, Node!

在管理界面中查看新代理

登录您的 Apigee Edge 帐号,然后转到“API 代理”页面。您会看到名为“hellonode”的代理在此处列出。

点击“hellonode”可查看代理的详细信息。在“开发”视图中,您可以看到上传的源代码、添加政策、修改流程等。

后续步骤

如需了解如何调试在 Apigee Edge 上运行的 Node.js 应用,请参阅调试 Node.js 代理并对其进行问题排查