Konfigurierbaren API-Proxy erstellen

Diese Seite gilt für Apigee und Apigee Hybrid.

Apigee Edge-Dokumentation aufrufen

Ab dem 17. August 2023 werden konfigurierbare API-Proxys (Vorschau) verworfen. Konfigurierbare Proxys sind nach dem 10. November 2023 nicht mehr verfügbar. Weitere Informationen finden Sie unter Verworfene Features.

Mit konfigurierbaren^VORSCHAU API-Proxys können Apigee-Nutzer einen einfachen Proxy mit einer deklarativen Konfiguration erstellen und bereitstellen, ähnlich wie beim Kubernetes-Ressourcenmodell. Auf dieser Seite werden die Schritte beschrieben, die zum Erstellen eines konfigurierbaren Proxys und zu seiner Bereitstellung mit dem neuen archivbasierten Bereitstellungsmechanismus erforderlich sind.

Weitere Informationen zu konfigurierbaren^VORSCHAU API-Proxys finden Sie unter Konfigurierbare API-Proxys.

Die konfigurierbare ^VORSCHAU der API-Proxy-Entwicklung ist nur für Kunden mit einem kostenpflichtigen Apigee-Abo verfügbar. Apigee-Kunden mit Pay as you go-Organisationen können programmierbare API-Proxys erstellen.

Hinweis

In dieser Anleitung wird davon ausgegangen, dass Sie bereits eine Apigee-Organisation bereitgestellt und Apigee installiert haben. Wenn nicht, finden Sie unter Einführung in die Bereitstellung die Schritte zum Installieren und Konfigurieren von Apigee, bevor Sie fortfahren.

Führen Sie vor Beginn dieser Anleitung die folgenden zusätzlichen Schritte aus:

1. Prüfen Sie, ob das Cloud SDK heruntergeladen und auf Ihrem Computer installiert wurde.

   Cloud SDK herunterladen

2. Aktualisieren Sie die gcloud-Komponenten:

   gcloud components update

3. Bestätigen Sie Ihre Apigee-Anmeldedaten und Ihre Organisationsdetails, da diese erforderlich sind, um eine Umgebung für den konfigurierbaren API-Proxy bereitzustellen.

Apigee-Umgebung bereitstellen

Bevor Sie Ihre Proxykonfiguration erstellen, müssen Sie eine Apigee-Umgebung bereitstellen, die konfigurierbare Proxys unterstützt. Eine Umgebung ist ein Laufzeitausführungskontext für die API-Proxys und für gemeinsam genutzte Abläufe in einer Organisation. Bevor Sie auf einen API-Proxy zugreifen können, müssen Sie ihn in einer Umgebung bereitstellen. Sie können einen API-Proxy in einer einzelnen Umgebung oder in mehreren Umgebungen bereitstellen.

Weitere Informationen finden Sie unter Umgebungen und Umgebungsgruppen.

To create a new environment in the UI:

1. Open the Apigee UI in a browser.
2. Select Admin > Environments > Overview in the left navigation menu.

   The UI displays a set of cards, each one representing an existing environment:

   

   If this is your first time accessing the Environment view, there will be no environments.

3. Click +ENVIRONMENT.

   The New environment dialog box displays:

   

4. Enter the following information in the New Environment dialog box:
   1. Display name: A friendly name for the environment that is used in the UI. For example, My Test Environment.

   2. Environment name: The programmatic name for the environment. This value will be part of the request URL for your API proxies and should not contain any spaces or other special characters. It can only letters, numbers, and hyphens. For example, my-environment-1.

      The new environment's name cannot be changed after it has been created.

   3. Description (optional): Additional information about the environment that you want to add as a reminder.
   4. Deployment type (Preview): Select Archive as the deployment type.
      Note: The deployment type used with this environment cannot be changed after the environment is created.

   All fields except Description are required.

5. Click OK.

   The card displays Pending Provisioning status while Apigee creates the new environment, as the following example shows:

   

   There can be a several minute delay before the new environment is provisioned.

   When it's done, the Apigee UI displays the new environment as a card with other environments that you have created:

   

Umgebung an eine Apigee-Instanz anhängen

Nachdem Sie eine neue Umgebung erstellt haben, müssen Sie sie an Ihre Apigee-Instanz anhängen, damit sie zugänglich ist. Dies ist über die Benutzeroberfläche möglich, wenn Sie eine neue Instanz erstellen (wenn die Umgebung bereits vorhanden ist). Wenn Sie in diesem Fall bereits eine Instanz erstellt haben, können Sie die neue Umgebung mit organizations.instances.attachments.create anhängen.

Ein Beispiel für den Prozess finden Sie in der Dokumentation zur Befehlszeilenbereitstellung unter Umgebung erstellen.

Für diese Anleitung können Sie den folgenden Befehl verwenden:

operation_name=$(curl -s -H "Authorization:Bearer $(gcloud auth print-access-token)" \
  "https://apigee.googleapis.com/v1/organizations/PROJECT_ID/instances/INSTANCE_NAME/attachments" \
  -X POST -H "content-type:application/json"\
  -d '{"environment":"ENV_NAME"}' | jq -r '.name' )

Wobei:

• PROJECT_ID ist die ID des Cloud-Projekts, in dem Ihre Apigee-Umgebung erstellt wird. Diese sollte mit dem Namen Ihrer Apigee-Organisation übereinstimmen.
• INSTANCE_NAME ist der Name Ihrer Apigee-Instanz.
• ENV_NAME ist der Name der Umgebung, in der der konfigurierbare API-Proxy bereitgestellt wird.

Dies gibt einen Vorgang mit langer Ausführungszeit zurück. Sie können den Vorgang mit dem folgenden Befehl abfragen, bis in der Ausgabe angezeigt wird, dass der Vorgang den Status done: true hat.

curl -s -H "Authorization:Bearer $(gcloud auth print-access-token)" \
  "https://apigee.googleapis.com/v1/$operation_name"

Umgebungsgruppe konfigurieren

Eine Umgebungsgruppe (in den Apigee-APIs manchmal als „envgroup“ bezeichnet) ist der grundlegende Mechanismus zum Definieren der Art und Weise, wie Anfragen an einzelne Umgebungen weitergeleitet werden. Sie definieren Hostnamen in Ihren Umgebungsgruppen (nicht in einzelnen Umgebungen) und Apigee leitet Anfragen mithilfe dieser Hostnamendefinitionen an die Umgebungen innerhalb einer Gruppe weiter.

Umgebungen, denen keine Gruppen zugewiesen sind, haben keine Hostnamen, die auf sie verweisen, und sind daher nicht zugänglich. Weitere Informationen finden Sie unter Umgebungsgruppen erstellen.

So konfigurieren Sie eine Umgebungsgruppe für Ihre neue Umgebung:

1. In the Apigee UI, select Admin > Environments > Groups.
2. Click +Environment Group:

   

   The Add an Environment Group dialog displays.

3. Enter a name for your new environment group:

   

   The name can contain only lower case letters, numbers, and hyphens. In addition, it must start with a letter, be at least two characters long, and cannot end with a hyphen. Valid names include my-env-group and prod2.

4. Click Add.

   Apigee creates a new environment group. This is usually a very quick operation.

   On a successful operation, Apigee confirms that the group has been created with a banner that looks like the following:

   

   Apigee also assigns a default host name to the new group.

5. (Optional) Assign additional host names to the new group by clicking for that group.

   Apigee displays the Environment group details pane:

   

6. Add host names to the Hostnames field. Each host name must be on a separate line.

7. Click Save when you're done.

   You can add and remove host names to this list at any time using the same procedure.

Proxy-Archiv erstellen

So erstellen Sie ein konfigurierbares^VORSCHAU API-Proxy-Archiv:

1. Erstellen Sie in Ihrer lokalen Umgebung ein Verzeichnis zum Speichern Ihres Apigee-Arbeitsbereichs in Ihrem lokalen Dateisystem. Dieses Verzeichnis dient wie unten dargestellt als Basis für Ihre konfigurierbare ^VORSCHAU-Dateistruktur der API-Proxys:

   .
   └── src
       └── main
           └── apigee
               ├── apiproxies
               │   ├── <proxy-name>
               │   │   └── config.yaml
               │   ├── <proxy-name>
               │   │   └── config.yaml
               └── environments
                   ├── <env-name>
                   │   ├── deployments.json
                   │   └── targetservers.json

   mkdir -p SOURCE_DIR/src/main/apigee/apiproxies/PROXY_NAME

   wobei

   • SOURCE_DIR ist der Name des Archivverzeichnisses.
   • PROXY_NAME ist der Name des konfigurierbaren Proxys.

   Beispiel:

   mkdir -p my-dir/src/main/apigee/apiproxies/my-proxy

   Hinweis: Verwenden Sie diesen Befehl nur für MacOS- oder Linux-basierte Systeme.
2. Erstellen Sie mit dem folgenden Befehl eine neue Datei für Ihre Proxykonfiguration:

   vi SOURCE_DIR/src/main/apigee/apiproxies/PROXY_NAME/config.yaml

   Beispiel:

   vi my-dir/src/main/apigee/apiproxies/my-proxy/config.yaml

   Ihre Proxykonfigurationsdatei muss einen der folgenden Dateinamen verwenden:

   • config.yaml:
   • config.json
   • config.yml
3. Kopieren Sie die folgende Proxykonfiguration in die neue Datei config.yaml:

   # config.yaml
   
   basepath: "/helloworld"
   operations:
   - id: get-user
     http_match:
     - path_template: "/user"
       method: GET
   target:
     uri: "https://mocktarget.apigee.net"
   

4. Erstellen Sie mit dem folgenden Befehl eine deployments.json-Datei:

   vi SOURCE_DIR/src/main/apigee/environments/ENV_NAME/deployments.json
   

   Beispiel:

   vi my-dir/src/main/apigee/environments/prod/deployments.json

5. Kopieren Sie Folgendes in die neue deployments.json-Datei:

{
  "proxies" : ["PROXY_NAME"]
}
  

Weitere Beispiele finden Sie unter Beispiele für Konfigurationen konfigurierbarer Proxys.

Archiv bereitstellen

Verwenden Sie den folgenden gcloud-Befehl, um ein Archiv in einer Apigee-Umgebung bereitzustellen:

gcloud alpha apigee archives deploy \
--organization=PROJECT_ID \
--environment=ENV_NAME \
--source=SOURCE_DIR

Beispiel:

gcloud alpha apigee archives deploy \
--organization=my-project \
--environment=prod \
--source=my-dir

Sie müssen die Apigee-Umgebung angeben, in der Sie das Archiv mit dem Flag --environment bereitstellen möchten. Die Apigee-Umgebung muss für Archivbereitstellungen aktiviert sein.

Hinweis: Wenn Sie zuvor ein Archiv in einer Apigee-Umgebung bereitgestellt haben, werden alle API-Proxys neu bereitgestellt und unabhängig von den im Archiv enthaltenen Änderungen neu erstellt.

Weitere Informationen zum Verwalten von Archivbereitstellungen finden Sie unter Archive in einer Apigee-Umgebung bereitstellen und verwalten.

Status der Archivbereitstellung prüfen

Mit dem Befehl gcloud alpha apigee operations können Sie den Status der Archivierung überprüfen.

Das folgende Beispiel zeigt den Status der Archivbereitstellung für den Vorgang mit der Überarbeitungs-ID 439fa3f7-6aa4-42ad-8b12-3ca912c75d5c: IN_PROGRESS.

gcloud alpha apigee operations describe b64c2665-b5ac-43cc-9e2d-232e8895c2ed

Im Folgenden finden Sie ein Beispiel für die Antwort:

Using Apigee organization 'myorg'
Waiting for operation [b64c2665-b5ac-43cc-9e2d-232e8895c2ed] to complete...done.

Weitere Informationen zum Auflisten von Archivbereitstellungen, zum Anzeigen von Details Ihrer Bereitstellungen oder zum Löschen einer Umgebung mit einer Archivbereitstellung finden Sie unter Archive in einer Apigee-Umgebung bereitstellen und verwalten.