Google verwendet KI-Technologie, um Inhalte in Ihre bevorzugte Sprache zu übersetzen. KI-Übersetzungen können Fehler enthalten.

Eigenständige Node.js-Anwendung bereitstellen

Sie lesen gerade die Dokumentation zu Apigee Edge.
Zur Dokumentation zu Apigee X. info

Hinweis zur Einstellung von Private Cloud

Unterstützung für Node.js-Proxys und sichere Tresore

Seit 2013 unterstützt Apigee die Verwendung von Node.js-Proxys in Apigee Edge über Trireme. Damit können Sie Ihren Node.js-Code in Apigee Edge for Private Cloud ausführen und als API verfügbar machen.

Apigee empfiehlt Private Cloud-Kunden, die folgenden Schritte auszuführen:

Daten in sicheren Tresoren zu verschlüsselten Schlüssel/Wert-Zuordnungen (Key Value Maps, KVMs) migrieren, um über einen API-Proxy auf vertrauliche Daten zuzugreifen.
API-Proxys, die auf Trireme (Node.js) basieren, zu einer nativen Node.js-Umgebung außerhalb von Apigee migrieren.

Siehe auch Apigee-Einstellung und -Ausmusterung.

In diesem Thema wird erläutert, wie Sie eine Node.js-Anwendung von Ihrem lokalen System in Apigee Edge bereitstellen. Außerdem wird beschrieben, wie Sie das Befehlszeilentool apigeetool verwenden, um Node.js-Anwendungen in Apigee Edge bereitzustellen.

Node.js-Code in Apigee Edge bereitstellen

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

Angenommen, Sie haben mit Express eine Webanwendung in Node.js erstellt. Die Anwendung wird als HTTP-Server ausgeführt, der auf HTTP-Anfragen wartet, diese verarbeitet, Daten zurückgibt usw. Wenn Sie apigeetool verwenden, um eine Node.js -Anwendung in Edge bereitzustellen, wird sie in einen Proxy eingebunden und im Kontext der Edge -Plattform ausgeführt. Sie können Ihre Anwendung dann über die neue Proxy-URL aufrufen und sie mit Standard-Edge-Funktionen wie OAuth-Sicherheit, Kontingentrichtlinien, Richtlinien zum Schutz vor Bedrohungen , bedingten Abläufen und Caching erweitern.

Was macht apigeetool?

Wenn Sie das Programm apigeetool mit der Option deploynodeapp ausführen, passiert Folgendes:

Es wird ein API-Proxy-Konfigurationsset für die Node.js-Anwendung generiert.
Die Node.js-Anwendung wird mit allen Node.js-Paketen verpackt, die mit NPM (Node Packaged Modules) installiert wurden.
Das API-Proxy-Konfigurationsset wird mit der Edge Management API in die angegebene Organisation in Apigee Edge importiert.
Der API-Proxy wird in einer Umgebung bereitgestellt.
Die Node.js-Anwendung wird in Apigee Edge ausgeführt und über das Netzwerk verfügbar gemacht.

Vorbereitung auf die Verwendung von apigeetool

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

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

Installation über npm

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

$ sudo npm install -g apigeetool

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

Normalerweise werden Module mit der Option `-g` auf *nix-basierten Computern in: /usr/local/lib/node_modules/apigeetool platziert.

Installation über GitHub

Laden Sie die API Platform Tools von GitHub herunter oder klonen Sie sie. Eine Installationsanleitung finden Sie in der README-Datei im Stammverzeichnis des Repositorys.

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

Nach Abschluss der Installation muss sich die ausführbare Datei apigeetool in Ihrem Pfad befinden. Sie können sie mit dem folgenden Befehl testen:

$ apigeetool -h

Node.js-Anwendung mit apigeetool in Edge bereitstellen

Hinweis: Bevor Sie die Anwendung bereitstellen, benötigen Sie den Namen Ihrer Apigee Edge-Organisation, Ihren Nutzernamen und das Passwort für Ihr Apigee Edge-Konto. Diese Informationen sind erforderlich, um den Befehl apigeetool korrekt zu formulieren.

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

Wechseln Sie in einem Terminalfenster mit cd zum Stammverzeichnis Ihrer Node.js-Anwendung.

Führen Sie das apigeetool Programm mit dem deploynodeapp Befehl 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

Prüfen Sie die Ausgabe im Terminalfenster. Sie sollte so aussehen:
```
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: deployed“ angezeigt wird, ist alles erledigt. Alles ist reibungslos verlaufen. Ihre Node.js-Anwendung ist in einen API-Proxy eingebunden, in Edge bereitgestellt und wird ausgeführt. Sie wartet auf Anfragen. Sie kann jetzt getestet werden.

Testen Sie Ihren Proxy. Beispiel:

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

Melden Sie sich bei Bedarf in Ihrem Apigee Edge-Konto an und rufen Sie die Seite „API-Proxys“ der Management-Benutzeroberfläche auf. Dort wird Ihr neuer Proxy aufgeführt.

Umgang von apigeetool mit abhängigen Dateien und Modulen

Wenn Ihre Node.js-Anwendung von installierten Modulen abhängt, verarbeitet apigeetool sie, indem der node_modules Ordner gezippt und dem Proxy-Bundle hinzugefügt wird. Es sind keine weiteren Maßnahmen erforderlich. Dasselbe gilt für alle Verzeichnisse, die zusätzlichen Quellcode enthalten. Das Programm apigeetool zippt sie und stellt sie mit dem Bundle bereit.

Sie können Dateien in diesen gezippten Verzeichnissen nicht im Editor der Edge Management UI bearbeiten. Wenn Sie Änderungen vornehmen müssen, können Sie Ihr Projekt exportieren, die Dateien lokal bearbeiten und dann mit apigeetool neu bereitstellen oder das exportierte Projekt über die Management UI importieren. Weitere Informationen finden Sie unter "Proxy mit Node.js-Code exportieren und importieren".

Grundlegende Informationen zur Verwendung von apigeetool

Grundlegende Informationen zu den Eingabeparametern des Programms apigeetool erhalten Sie mit dem folgenden Befehl:

$ 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, eine vorhandene Node.js-Anwendung in einen API-Proxy zu integrieren, besteht darin, die Anwendung beim Erstellen des Proxys hinzuzufügen. Das ist vollständig über die Management UI und das Dialogfeld „Neuer API-Proxy“ möglich.

Klicken Sie auf der Übersichtsseite für API-Proxys auf + API-Proxy.
Wählen Sie im Dialogfeld „Neuer API-Proxy“ die Option Vorhandenes Node.js aus.
Klicken Sie auf die Schaltfläche Dateien auswählen , um eine oder mehrere Node.js-Dateien zum Importieren 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 Befehls zeile mit dem Befehl „node“ aufrufen.
Geben Sie dem Proxy einen Namen. In diesem Beispiel nennen wir ihn hellonode.
Fügen Sie dem Basispfad des Projekts die Version /v1 hinzu. Es gilt als Best Practice, Ihre API zu versionieren.
Klicken Sie auf Erstellen.
Klicken Sie auf Entwickeln , um die Ansicht „Entwickeln“ aufzurufen.
Öffnen Sie die Datei TargetEndpoint im Codeeditor.

Das <ScriptTarget> Element muss die Haupt-Node.js-Datei angeben: wie folgt:

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

Klicken Sie auf Speichern.

Neue Node.js-Ressourcen dateien hinzufügen und aufrufen

Eine andere Möglichkeit, einem Proxy Node.js-Code hinzuzufügen, besteht darin, ihn direkt hinzuzufügen, entweder über die Benutzeroberfläche oder durch Hochladen aus Ihrem lokalen Dateisystem. Sie können auch angeben, welche Node.js-Datei die Haupt datei ist. Das ist die Datei, die Edge beim Bereitstellen des Proxys aufruft.

Neue Node.js-Dateien über die Benutzeroberfläche hinzufügen

Über die Management 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 funktioniert.

So erstellen Sie eine neue Node.js-Ressourcendatei:

Wählen Sie in der Ansicht „Entwickeln“ im Menü „Neu“ die Option Neues Skript aus.
Wählen Sie im Dialogfeld „Skript hinzufügen“ den Dateityp Node aus und geben Sie einen Namen für das Skript ein.
Klicken Sie auf Hinzufügen.

Die neue, leere Node.js-Datei wird im Editor geöffnet. Sie können Ihren Code in die Datei kopieren. Die Datei wird auch im Bereich „Skripts“ der Navigation 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 importieren Sie eine Node.js-Datei aus Ihrem Dateisystem in den Proxy:

Wählen Sie in der Ansicht „Entwickeln“ im Menü „Neu“ die Option Neues Skript aus.
Klicken Sie im Dialogfeld „Skript hinzufügen“ auf Import Skript.
Wählen Sie mit dem Dateitool Ihre Node.js-Datei aus.
Der Name der Datei wird im Dialogfeld hinzugefügt. Sie können ihn aber bei Bedarf ändern.
Klicken Sie auf Hinzufügen. Die Datei wird im Bereich „Skripts“ der Navigation 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 eine neu importierte oder erstellte Node.js-Datei nicht einfach aufrufen. Der Grund dafür ist, dass in Edge eine Node.js-Datei als die Hauptdatei festgelegt sein muss. Die Hauptdatei wird im <ScriptTarget> Element der Zieldatei angegeben. So geben Sie an, welche Datei die Haupt Node.js-Datei ist:

Klicken Sie in der Navigation unter „Zielendpunkte“ auf den Namen des Zielendpunkts (normalerweise „default“).
Bearbeiten Sie im Codeeditor das Element <ScriptTarget>, indem Sie das <ResourceURL> so ändern, dass der Name der Datei angegeben wird, die die Haupt-Node.js-Datei 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.

Jetzt können Sie die Datei mit dem zuvor verwendeten Proxy-Pfad aufrufen. Wir haben uns beispielsweise das Beispiel „Hello World!“ angesehen, in dem der Basispfad v1/helloangegeben ist. Sie können den Basispfad jedoch ändern, indem Sie den Proxy-Endpunkt bearbeiten.

Klicken Sie in der Navigation unter „Proxy-Endpunkte“ auf den Namen des Proxy-Endpunkts (normalerweise „default“).
Bearbeiten Sie im Codeeditor das Element <HttpProxyConnection>, indem Sie <BasePath> in einen beliebigen Namen ändern. Wenn der aktuelle <BasePath> v1/hello ist und Sie ihn in v1/my-node-file ändern möchten, ändern Sie das Element <BasePath> 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 ihn jederzeit wieder in Ihr System exportieren , dort bearbeiten und dann über die Management UI wieder in Edge importieren. Diese Art der Entwicklungstechnik wird häufig verwendet.

Klicken Sie auf der Übersichtsseite für 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 Funktion „Herunterladen“ werden keine Verzeichnisse entpackt, die beim Bereitstellen des Proxys gezippt wurden, z. B. node_modules oder andere Ordner mit Quellcode. Sie müssen sie 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, Hinzufügen von Node.js zu einem vorhandenen API-Proxy, wird erläutert, wie Sie einem vorhandenen Proxy in Ihrem Dateisystem eine Node.js-Anwendung hinzufügen und sie in Edge bereitstellen.