Diese Seite wurde von der Cloud Translation API übersetzt.

Eigenständige Node.js-Anwendung bereitstellen

Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation weitere Informationen

In diesem Thema wird erläutert, wie Sie eine Node.js-Anwendung von Ihrem lokalen System in Apigee Edge bereitstellen. In diesem Thema wird erläutert, wie Sie mit dem Befehlszeilentool apigeetool Node.js-Anwendungen in Apigee Edge bereitstellen.

Node.js-Code in Apigee Edge bereitstellen

Sie können eine vorhandene Node.js API-Anwendung, einschließlich aller abhängigen Node.js-Module, mithilfe eines Befehlszeilenprogramms namens apigeetool von Ihrem lokalen System in Apigee Edge bereitstellen. Das Dienstprogramm bündelt die Anwendung und ihre Abhängigkeiten automatisch in einem API-Proxy und stellt sie in Edge bereit.

Angenommen, Sie haben Express zum Erstellen einer Webanwendung in Node.js verwendet. Die Anwendung wird als HTTP-Server ausgeführt, der auf HTTP-Anfragen wartet, diese verarbeitet, Daten zurückgibt usw. Wenn Sie mit apigeetool eine Node.js-Anwendung in Edge bereitstellen, ist diese in einen Proxy eingebunden und wird im Kontext der Edge-Plattform ausgeführt. Sie können Ihre Anwendung dann über die neue Proxy-URL aufrufen und einen Mehrwert bieten, indem Sie Standard-Edge-Features wie OAuth-Sicherheit, Kontingentrichtlinien, Richtlinien für den Bedrohungsschutz, bedingte Datenflüsse, Caching und viele andere „anpassen“.

Was macht Apigeetool?

Wenn Sie das Dienstprogramm apigeetool mit der Option deploynodeapp ausführen, geschieht Folgendes:

Erzeugt ein API-Proxy-Konfigurations-Bundle für die Node.js-Anwendung.
Verpackt die Node.js-Anwendung mit allen Node.js-Paketen, die mit NPM (Node Packaged Modules) installiert sind.
Importiert das API-Proxy-Konfigurations-Bundle mithilfe der Edge-Verwaltungs-API in die angegebene Organisation in Apigee Edge.
Stellt den API-Proxy in einer Umgebung bereit.
Führt die Node.js-Anwendung auf Apigee Edge aus und stellt sie über das Netzwerk zur Verfügung.

Verwendung von Apigeetool vorbereiten

Bevor Sie beginnen, müssen Sie das Dienstprogramm apigeetool installieren.

Sie können Apigeetool entweder über npm installieren oder den Code aus GitHub klonen und verknüpfen.

Installation von npm

Das Modul apigeetool und seine Abhängigkeiten wurden für Node.js entwickelt und sind über npm mit dem folgenden Befehl verfügbar:

$ sudo npm install -g apigeetool

Hinweis: sudo ist möglicherweise mit der Option -g erforderlich, die Apigeetool in Ihren PFAD setzt. Wenn Sie -g nicht verwenden, müssen Sie apigeetool manuell zu Ihrem PFAD hinzufügen.

In der Regel werden durch die Option „-g“ Module in /usr/local/lib/node_modules/apigeetool auf *nix-basierten Maschinen platziert.

Installation von GitHub

Laden Sie die API-Plattformtools entweder von GitHub herunter oder klonen Sie sie. Installationsanweisungen finden Sie in der INFO-Datei im Repository-Stammverzeichnis.

$ git clone https://github.com/apigee/apigeetool-node.git

Wenn Sie die Installation abgeschlossen haben, muss sich die ausführbare apigeetool-Datei im Pfad befinden. Sie können es testen, indem Sie Folgendes eingeben:

$ apigeetool -h

Node.js-Anwendung mit Apigeetool in Edge bereitstellen

Hinweis: Vor der Bereitstellung benötigen Sie den Organisationsnamen, den Nutzernamen und das Passwort von Apigee Edge für Ihr Apigee Edge-Konto. Sie benötigen diese Informationen, um den Befehl apigeetool korrekt zu erstellen.

So stellen Sie eine Node.js-Anwendung mit apigeetool bereit:

Führen Sie in einem Terminalfenster cd das Stammverzeichnis Ihrer Node.js-Anwendung aus.

Führen Sie das Dienstprogramm apigeetool mit dem Befehl deploynodeapp aus:

$ apigeetool deploynodeapp -n {A name for your new proxy} -d {The root directory of your Node.js app} -m {The name of the main Node.js file} -o {Your org name on Edge} -e {The environment to deploy to} -b {The base URL for your proxy} -u {Your Edge email address} -p {Your Edge password}

Beispiel:

$ apigeetool deploynodeapp -n myNodeApp -d . -m server.js -o myorg -e test -b /myNodeApp -u ntesla -p myPassword

Überprüfen Sie die Ausgabe in Ihrem Terminalfenster. Sie sieht in etwa so aus:
```
Importing new application myNodeApp
Imported new app revision 1
Deploying revision 1
  Deployed.
Proxy: "myNodeApp" Revision 1
  Environment: test BasePath: /myNodeApp
  Status: deployed
```
Wenn „Status: Deploy“ angezeigt wird, war es schon alles. Es lief alles reibungslos. Ihre Node.js-Anwendung ist in einen API-Proxy eingebettet, der in Edge bereitgestellt wird. Er wird ausgeführt und wartet auf die Verarbeitung von Anfragen. Sie können sie jetzt testen.

Testen Sie Ihren Proxy. Beispiel:

$ curl http://myorg-test.apigee.net/myNodeApp
Hello, My Node App!

Wenn Sie möchten, melden Sie sich bei Ihrem Apigee Edge-Konto an und rufen Sie die Seite der API-Proxys der Verwaltungs-UI auf. Der neue Proxy wird dort aufgeführt.

So verarbeitet Apigeetool abhängige Dateien und Module

Wenn Ihre Node.js-Anwendung von installierten Modulen abhängt, verarbeitet apigeetool diese durch Komprimierung des Ordners node_modules und Hinzufügen zum Proxy-Bundle. Es sind keine weiteren Maßnahmen erforderlich. Dasselbe gilt für Verzeichnisse, die zusätzlichen Quellcode enthalten. Das Apigeetool-Dienstprogramm komprimiert sie und stellt sie mit dem Bundle bereit.

Sie können in diesen ZIP-Verzeichnissen keine Dateien im Editor der Edge-Management-Benutzeroberfläche bearbeiten. Wenn Sie sie ändern müssen, können Sie Ihr Projekt exportieren, die Dateien lokal bearbeiten und dann mit Apigeetool oder durch Importieren des exportierten Projekts über die Verwaltungs-UI noch einmal bereitstellen. Siehe auch Proxy mit Node.js-Code exportieren und importieren.

Grundlegende Nutzungsinformationen für Apigeetool

Geben Sie Folgendes ein, um grundlegende Informationen zur Verwendung der Eingabeparameter des apigeetool-Dienstprogramms zu erhalten:

$ apigeetool deploynodeapp -h

  Usage: deploynodeapp -n [name] -o [organization] -e [environment]
  -d [directory name] -m [main script file]
  -u [username] -p [password]
  -b [base path] -l [apigee API url] -z [zip file] -i -h
  -o Apigee organization name
  -e Apigee environment name
  -n Apigee proxy name
  -d Apigee proxy directory
  -m Main script name: Should be at the top level of the directory
  -u Apigee user name
  -p Apigee password
  -b Base path (optional, defaults to /)
  -L Apigee API URL (optional, defaults to https://api.enterprise.apigee.com)
  -z ZIP file to save (optional for debugging)
  -i import only, do not deploy
  -R Resolve Node.js modules on Apigee Edge. Equivalent to running npm install on your project. 
  -U Uploads Node.js modules to Apigee Edge. 
  -h Print this message

Neuen Proxy mit vorhandenen Node.js-Dateien erstellen

Eine andere Möglichkeit zum Einbinden einer vorhandenen Node.js-Anwendung in einen API-Proxy besteht darin, die Anwendung beim Erstellen des Proxys hinzuzufügen. Dies ist vollständig über die Verwaltungsoberfläche und das Dialogfeld „Neuer API-Proxy“ möglich.

Klicken Sie auf der Übersichtsseite des API-Proxys auf +API-Proxy.
Wählen Sie im Dialogfeld „Neuer API-Proxy“ die Option Vorhandenes Node.js aus.
Verwenden Sie die Schaltfläche Dateien auswählen, um eine oder mehrere Node.js-Dateien für den Import auszuwählen.
Hinweis: Wenn Sie mehrere Node.js-Dateien hochladen, müssen Sie angeben, welche die Hauptdatei ist. (Die Hauptdatei ist die Datei, die Sie über die Befehlszeile mit dem Knotenbefehl aufrufen.)
Geben Sie dem Proxy einen Namen. In diesem Beispiel nennen wir sie hellonode.
Fügen Sie dem Basispfad des Projekts die Version /v1 hinzu. Eine Best Practice ist die Versionsverwaltung der API.
Klicken Sie auf Build.
Klicken Sie auf Develop, um die Ansicht "Develop" aufzurufen.
Öffnen Sie die Datei TargetEndpoint im Code-Editor.

Achten Sie darauf, dass das Element <ScriptTarget> die Node.js-Hauptdatei so angibt:

<ScriptTarget>
        <ResourceURL>node://server.js</ResourceURL>
        <Properties/>
</ScriptTarget>

Klicken Sie auf Speichern.

Neue Node.js-Ressourcendateien hinzufügen und aufrufen

Eine andere Möglichkeit, um Node.js-Code zu einem Proxy hinzuzufügen, besteht darin, ihn direkt über die UI oder durch Hochladen aus Ihrem lokalen Dateisystem hinzuzufügen. Sie können auch angeben, welche Node.js-Datei die Hauptdatei ist. Dies ist die Datei, die Edge aufruft, wenn der Proxy bereitgestellt wird.

Neue Node.js-Dateien über die UI hinzufügen

Über die Verwaltungs-UI können Sie einem Proxy auf der Edge-Plattform zusätzliche Node.js-Quelldateien hinzufügen. Sie können sie direkt in der Benutzeroberfläche erstellen oder aus Ihrem Dateisystem importieren. Sehen wir uns zuerst an, wie das über die Benutzeroberfläche geht.

So erstellen Sie eine neue Node.js-Ressourcendatei:

Wählen Sie in der Entwicklungsansicht im Menü "Neu" die Option Neues Skript aus.
Wählen Sie im Dialogfeld „Add Script“ (Skript hinzufügen) den Dateityp Knoten aus und geben Sie dem Script einen Namen.
Klicken Sie auf Hinzufügen.

Die neue, leere Node.js-Datei wird im Editor geöffnet. Sie können den Code ausschneiden und in die Datei einfügen. Die Datei wird auch im Abschnitt Scripts des Navigators angezeigt.

[[{"type":"media","view_mode":"media_large","fid":"2431","attributes":{"alt":"","class":"media-image","height":"312","typeof":"foaf:Image","width":"417"}}]]

Node.js-Dateien aus Ihrem Dateisystem importieren

So import Sie eine Node.js-Datei aus Ihrem Dateisystem in den Proxy:

Wählen Sie in der Entwicklungsansicht im Menü "Neu" die Option Neues Skript aus.
Klicken Sie im Dialogfeld "Skript hinzufügen" auf Skript importieren.
Wählen Sie mit dem Dateitool Ihre Node.js-Datei aus.
Der Name der Datei wird dem Dialogfeld hinzugefügt, Sie können ihn aber bei Bedarf ändern.
Klicken Sie auf Hinzufügen. Die Datei wird im Bereich „Skripts“ des Navigators angezeigt und im Editor geöffnet.
Klicken Sie auf Speichern.

Wenn Sie die importierte Datei aufrufen möchten, ist ein zusätzlicher Schritt erforderlich, wie im nächsten Abschnitt erläutert.

Importierte Node.js-Datei aufrufen

Sie können nicht einfach eine neu importierte oder erstellte Node.js-Datei aufrufen. Dies liegt daran, dass Edge erfordert, dass eine Node.js-Datei die main-Datei ist. Die Hauptdatei wird im <ScriptTarget>-Element der Definition des Zielendpunkts angegeben. So legen Sie fest, welche Datei die Node.js-Hauptdatei ist:

Klicken Sie im Navigator unter "Zielendpunkte" auf den Namen des Zielendpunkts (normalerweise default genannt).
Bearbeiten Sie im Code-Editor das <ScriptTarget>-Element, indem Sie <ResourceURL> in den Namen der Datei ändern, die die Node.js-Hauptdatei sein soll. Wenn beispielsweise eine Datei namens hello-world.js die Hauptdatei sein soll, geben Sie node://hello-world.js im Element ResourceURL ein.
Klicken Sie auf Speichern.

An dieser Stelle können Sie die Datei mit dem zuvor verwendeten Proxy-Pfad aufrufen. Beispielsweise haben wir uns das „Hello World!“-Beispiel angesehen, in dem der Basispfad v1/hello angegeben ist. Sie können den Basispfad jedoch ändern, indem Sie den Proxy-Endpunkt bearbeiten.

Klicken Sie im Navigator unter "Proxyendpunkte" auf den Namen des Proxyendpunkts (normalerweise als default bezeichnet).
Bearbeiten Sie im Code-Editor das <HttpProxyConnection>-Element, indem Sie <BasePath> in einen beliebigen Namen ändern. Wenn der aktuelle <BasePath> beispielsweise v1/hello ist und v1/my-node-file sein soll, ändern Sie das <BasePath>-Element so:

<BasePath>/v1/my-node-file</BasePath>
Klicken Sie auf Speichern.

Rufen Sie den Proxy mit dem neuen Basispfad auf:

$ curl http://myorg-test.apigee.net/v1/my-node-file
Hello, World!

Proxy mit Node.js-Code exportieren und importieren

Nachdem Sie einen Proxy mit Node.js-Code in Edge bereitgestellt haben, können Sie den Proxy jederzeit wieder in Ihr System exportieren, dort bearbeiten und dann über die Verwaltungs-UI noch einmal in Edge importieren. Diese Art der Umlaufentwicklungstechnik wird häufig verwendet.

Klicken Sie auf der Übersichtsseite des API-Proxys auf Entwickeln.
Wählen Sie auf der Seite „Entwickeln“ die Option Aktuelle Überarbeitung herunterladen aus.
Entpacken Sie die heruntergeladene Datei auf Ihrem System.

Hinweis: Mit der Downloadfunktion werden keine Verzeichnisse entpackt, die bei der Bereitstellung des Proxys komprimiert wurden, z. B. node_modules oder andere Ordner mit Quellcode. Sie müssen die Dateien manuell entpacken, nachdem der Proxy auf Ihr System heruntergeladen wurde.

Sie können das Proxy-Bundle wieder in Edge importieren, indem Sie im selben Menü die Option In neue Überarbeitung importieren auswählen.

Sie können die API auch zum Bereitstellen von Proxys verwenden. Weitere Informationen finden Sie unter Proxys über die Befehlszeile bereitstellen.

Nächste Schritte

Im nächsten Thema, Node.js zu einem vorhandenen API-Proxy hinzufügen wird erläutert, wie Sie eine Node.js-Anwendung zu einem vorhandenen Proxy in Ihrem Dateisystem hinzufügen und in Edge bereitstellen.