將 Node.js 新增至現有的 API Proxy

您目前查看的是 Apigee Edge 說明文件。
前往 Apigee X 說明文件。 info

簡介

本主題說明如何將 Node.js 應用程式新增至本機檔案系統的現有 Proxy，以及如何將 Proxy 部署至 Apigee Edge。

準備開發環境

在本主題中，我們假設您已在本機系統上設定 Proxy 開發環境，並想將 Node.js 應用程式整合至該環境。

包含 Node.js 應用程式的 Proxy 應用程式基本結構，會遵循下圖所示模式，包含基本 /apiproxy 資料夾，以及 resources、targets 和 proxies 的子資料夾。Node.js 檔案必須放在 apiproxy/resources/node 資料夾中。其他資料夾則包含定義 Proxy 和目標端點、Proxy 流程、條件流程等的 XML 檔案。如要進一步瞭解 API Proxy 結構，請參閱 API Proxy 設定參考資料。

請注意，Proxy 中的所有 Node.js 程式碼都必須放在 /apiproxy/resources/node 下方。這是 Edge 部署時預期會找到該檔案的位置。

使用 ScriptTarget 指定 Node.js 目標

如要將 Node.js 整合至 Proxy，請在目標端點的 XML 檔案中指定 <ScriptTarget> 元素。在 Proxy 檔案結構中，這個 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> 元素指定後端服務的網址，但 Node.js 應用程式會使用 <ScriptTarget> 元素直接參照，如下所示：

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

<ResourceURL> 參數一律須以 node:// 為前置字元，接著是主要的 Node.js 指令碼名稱。如先前所述，Node.js 資源必須位於 API Proxy 範圍的 /apiproxy/resources/node 中。

您可以在 ScriptTarget 中設定其他參數。詳情請參閱「 進階 ScriptTarget 設定」。

以本範例為例，以下是主要 Node.js 檔案 (名為 server.js) 的原始碼。這是基本的 HTTP 伺服器，收到要求時會傳回「Hello World!」：

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');
});

總而言之，假設 main Node.js 應用程式是在名為 server.js 的檔案中實作，且端點設定都名為 default.xml，則包含 Node.js 指令碼的 API Proxy 具有下列結構：

/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

安裝依附元件後，您就可以將 Proxy 部署至 Edge。

將 Node.js 應用程式部署至 Apigee Edge

部署前，您需要知道 Apigee Edge 帳戶的機構名稱、使用者名稱和密碼。您需要這項資訊，才能正確建立部署工具指令。

請參考以下指令。這會假設您位於 Proxy 的根目錄 (使用 -d 標記)。如果 Proxy 名為 foo，請從 foo 目錄輸入下列指令：

$ apigeetool deployproxy -u username -p password -o org -e test -n hellonode -d .
如要瞭解各個指令標記的意義，請執行下列操作：

$ apigeetool deployproxy -h

如需簡要說明：

  • -n：這個標記可讓您指定應用程式部署時建立的 Proxy 名稱。管理 UI 中會顯示這個名稱。
  • -d 指定 API Proxy 的根目錄。
  • -o、-e、-u 和 -p 會指定機構名稱、部署環境、使用者名稱和密碼。
這樣就完成了！Node.js 應用程式會包裝在 API Proxy 中，部署至 Edge 並執行。等待要求，隨時可供測試。

測試新的 API Proxy

您剛才已將 Node.js 應用程式新增至現有的 API Proxy，並將該 Proxy 部署至 Apigee Edge！如要測試，請執行這項 cURL 指令。我們假設您使用預設基本路徑 (/) (基本路徑是在 Proxy 端點設定檔中指定)。請務必將 org_name 替換為貴機構的名稱。如果沒有安裝 cURL，可以在瀏覽器中輸入網址。

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

在管理 UI 中查看新 Proxy

登入 Apigee Edge 帳戶，然後前往 API Proxy 頁面。您會看到名為「hellonode」的 Proxy 列於其中。

按一下「hellonode」即可查看 Proxy 的詳細資料。在「開發」檢視畫面中，您可以查看上傳的原始碼、新增政策、編輯流程等。

後續步驟

如要瞭解如何對在 Apigee Edge 上執行的 Node.js 應用程式進行偵錯，請參閱「偵錯及排解 Node.js 代理程式問題」。