Schritt 6: API veröffentlichen

Diese Seite gilt für Apigee und Apigee Hybrid.

Apigee Edge-Dokumentation aufrufen

In diesem Schritt veröffentlichen Sie eine API im Portal. Gehen Sie dazu so vor:

1. API-Proxy aus einer Spezifikation erstellen
2. API-Produkt erstellen
3. API im Portal veröffentlichen

Schritt 1: API-Proxy aus einer Spezifikation erstellen

Erstellen Sie einen API-Proxy aus einer OpenAPI-Spezifikation, die die API beschreibt.

So erstellen Sie einen API-Proxy aus einer OpenAPI-Spezifikation:

Cloud Console-UI

1. Rufen Sie in Apigee in der Cloud Console die Seite Proxy-Entwicklung > API-Proxys auf.

   Zu „API-Proxys“

2. Klicken Sie auf Erstellen. Der Assistent Proxy erstellen wird geöffnet und Sie werden aufgefordert, den Typ des zu erstellenden API-Proxys auszuwählen.

3. Klicken Sie in das Feld Proxyvorlage.

4. Klicken Sie auf OpenAPI-Spezifikationsvorlage, Reverse-Proxy (am häufigsten).

5. Öffnen Sie die folgende Datei in einem Browser und speichern Sie sie:

   https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget3.0.yaml

6. Klicken Sie unter Schritt 1: OpenAPI-Spezifikationen auf Durchsuchen.

7. Suchen Sie die OpenAPI-Spezifikationsdatei, die Sie gerade heruntergeladen haben, wählen Sie sie aus und klicken Sie dann auf Öffnen.

8. Klicken Sie auf Weiter.

9. In Schritt 2: Proxydetails werden die Felder mit Werten aus der OpenAPI-Spezifikation vorausgefüllt. Bearbeiten Sie das Feld Beschreibung so: API-Proxy für Hello World.

10. Klicken Sie auf Weiter.

11. Wählen Sie unter Schritt 3: Abläufe alle Vorgänge aus.

12. Klicken Sie auf Weiter.

13. Wählen Sie in Schritt 4: Bereitstellen die Umgebung aus, in der Sie die Bereitstellung vornehmen möchten.

14. Klicken Sie auf OK.

15. Klicken Sie auf Erstellen.

Hinweis: Es kann einige Momente dauern, bis der neue Proxy von Apigee bereitgestellt wird.

Wenn der Proxy bereitgestellt wird, wird in der Spalte Status im Abschnitt Bereitstellungen ein grünes Symbol angezeigt, das zeigt, dass die API-Proxy-Überarbeitung bereitgestellt ist. Wenn Sie den Mauszeiger auf das Statussymbol bewegen, werden weitere Informationen zum Deployment angezeigt.

Klassische UI

1. Wählen Sie in der Apigee-Benutzeroberfläche in der linken Navigationsleiste Entwickeln > API-Proxys aus, um die Seite "API-Proxys" zu öffnen.

2. Klicken Sie auf Neu erstellen.

   Der Assistent zum Erstellen von Proxys wird geöffnet und Sie werden aufgefordert, den Typ des zu erstellenden API-Proxys auszuwählen.

3. Klicken Sie unter Reverse-Proxy (am häufigsten) auf OpenAPI-Spezifikation verwenden.

   Das Dialogfeld OpenAPI-Spezifikation verwenden wird angezeigt.

4. Kopieren Sie auf die folgende URL und fügen Sie sie auf dem Tab URL in das Feld OpenAPI Spec URL ein:

   https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget3.0.yaml

5. Klicken Sie auf Auswählen. Der Assistent Proxy erstellen wird geöffnet und die Seite Proxy-Details wird mit Werten aus der OpenAPI-Spezifikation ausgefüllt.

   

6. Bearbeiten Sie das Feld Beschreibung so: API-Proxy für Hello World.

7. Klicken Sie auf Weiter.

8. Auf der Seite Richtlinien:

   • Wählen Sie unter Sicherheit: Autorisierung die Option Pass through (no authorization) aus.
   • Wählen Sie unter Sicherheit: Browser die Option CORS-Header hinzufügen aus.

   

9. Klicken Sie auf Weiter.

10. Prüfen Sie auf der Seite Abläufe, ob alle Vorgänge ausgewählt sind, und klicken Sie auf Weiter.

11. Wählen Sie auf der Seite Zusammenfassung unter Optionale Bereitstellung die Umgebung aus, in der Sie die Bereitstellung vornehmen möchten.

    

12. Klicken Sie auf Erstellen und bereitstellen.

Auf der Seite Zusammenfassung wird bestätigt, dass der neue API-Proxy erstellt und in der ausgewählten Umgebung bereitgestellt wurde.

Schritt 2: API-Produkt erstellen

Erstellen Sie ein API-Produkt, das die API-Ressourcen enthält, die Sie für Ihre API-Nutzer bereitstellen möchten.

So erstellen Sie ein API-Produkt:

1. Rufen Sie in Apigee in der Cloud Console die Seite Verteilung > API-Produkte auf.

   Zu den API-Produkten

2. Klicken Sie auf Erstellen. Die Seite Produktdetails wird angezeigt. Geben Sie die Produktdetails für Ihr API-Produkt ein.
   

   Hinweis: Die Felder Anzeigename und Beschreibung werden standardmäßig im Portal angezeigt, wenn Sie das API-Produkt veröffentlichen. Sie können die Werte in Schritt 3: API im Portal veröffentlichen bearbeiten.

   Feld	Wert
   Name	Hallo Welt
   Anzeigename	Hallo Welt
   Beschreibung	Einfaches „Hello World“-Beispiel
   Umgebung	Wählen Sie die Umgebung aus, in der der API-Proxy bereitgestellt wird.
   Zugriff	Öffentlich
   Zugriffsanfragen automatisch genehmigen	Aktiviert
   Kontingent	[keine Eingabe]
   Erlaubte OAuth-Bereiche	[keine Eingabe]

3. Klicken Sie unter Vorgänge auf Vorgang hinzufügen, um die Vorgänge auszuwählen, die dem API-Produkt hinzugefügt werden sollen.

   • Wählen Sie unter Quelle die Option API-Proxy und dann Mock-Target-API aus dem Drop-down-Menü aus.
   • Geben Sie unter Vorgang einen Schrägstrich (/) in das Feld Pfad ein. Ignorieren Sie die anderen Felder.

4. Klicken Sie auf Speichern, um den Vorgang zu speichern.

5. Klicken Sie auf Speichern, um das Produkt zu speichern.

Schritt 3: API im Portal veröffentlichen

Veröffentlichen Sie die API auf Ihrem Portal, damit Ihre Kunden sich darüber informieren und diese verwenden können.

So veröffentlichen Sie die API in Ihrem Portal:

Cloud Console-UI

1. Rufen Sie in der Apigee in Cloud Console die Seite Distribution > Portals auf.

   Zu Portalen

2. Klicken Sie auf die Zeile Mein erstes Portal, um das Portal zu öffnen.

3. Klicken Sie auf den Tab APIs.

4. Klicken Sie auf + API.

5. Wählen Sie für API-Produkt die Option Hello World aus.

6. Wählen Sie Veröffentlicht (im Katalog aufgeführt) aus, um die API in Ihrem Portal zu veröffentlichen.

7. Geben Sie für Anzeigetitel Hello World ein.

8. Klicken Sie unter Anzeigebild auf Auswählen.

9. Klicken Sie auf Assets.

10. Klicken Sie für home-background.jpg auf Vorschau.

11. Klicken Sie auf Auswählen.

12. So generieren Sie unter API-Dokumentation automatisch eine API-Referenzdokumentation aus einem Snapshot Ihrer OpenAPI-Spezifikation:

    1. Wählen Sie OpenAPI-Dokument aus.
    2. Klicken Sie auf Auswählen.
    3. Klicken Sie auf den Tab URL.
    4. Geben Sie helloworld in das Feld Spezifikationsname ein.
    5. Kopieren Sie die folgende URL und fügen Sie sie in das Feld URL ein:

       https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget3.0.yaml

    6. Klicken Sie auf Auswählen.

13. Klicken Sie auf Speichern.

Klassische UI

1. Gehen Sie in der Apigee-Benutzeroberfläche zur Seite „APIs“ in Ihrem Portal:
   1. Wählen Sie in der linken Navigationsleiste Veröffentlichen > Apps aus.
   2. Klicken Sie auf die Zeile Mein erstes Portal, um das Portal zu öffnen.
   3. Klicken Sie auf API-Katalog, um die Seite mit den APIs aufzurufen.
2. Klicken Sie auf + (Pluszeichen).
3. Wählen Sie Hello World im Dialogfeld API-Produkt zum Katalog hinzufügen aus und klicken Sie auf Weiter.
4. Konfigurieren Sie unter API-Details die folgenden Optionen:
   • Wählen Sie Veröffentlicht (im Katalog aufgeführt) aus, um die API in Ihrem Portal zu veröffentlichen.
   • Für Anzeigenbild:
     1. Klicken Sie auf Image auswählen.
     2. Klicken Sie im Dialogfeld Image auswählen auf home-background.jpg aus der Liste der vorhandenen Images.
     3. Klicken Sie auf Auswählen.
     4. Sehen Sie sich eine Vorschau des Images an und klicken Sie auf Auswählen.
   • Geben Sie unter Kategorien die Option Erste Schritte ein und drücken Sie die Eingabetaste.

   Behalten Sie für alle anderen Werte die Standardeinstellungen bei.

   

5. So generieren Sie unter API-Dokumentation automatisch eine API-Referenzdokumentation aus einem Snapshot Ihrer OpenAPI-Spezifikation:
   1. Wählen Sie OpenAPI-Dokument aus.
   2. Klicken Sie auf Dokument auswählen.
   3. Wählen Sie den Tab Von einer URL importieren aus.
   4. Geben Sie helloworld in das Feld Spezifikationsname ein.
   5. Kopieren Sie die folgende URL und fügen Sie sie in das Feld URL ein. Drücken Sie dann die Eingabetaste:

      https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget3.0.yaml

   6. Klicken Sie auf Auswählen.

   

6. Klicken Sie auf Speichern.

Schritt 4: API-Referenzdokumentation ansehen

So rufen Sie die API-Referenzdokumentation auf:

1. Klicken Sie in der Apigee-Benutzeroberfläche auf Live-Portal, um die Änderungen im Live-Portal aufzurufen oder das Live-Portal zu aktualisieren, falls es bereits in einem anderen Tab geöffnet ist.
2. Im Live-Portal:
   1. Klicken Sie in der oberen Navigationsleiste auf APIs, um die veröffentlichte API aufzurufen.
   2. Klicken Sie auf die Karte Hello World, um die API-Referenzdokumentation aufzurufen.
   3. Probieren Sie die API aus!

Glückwunsch! Sie haben die Anleitung erfolgreich abgeschlossen. Möchten Sie mehr darüber erfahren? Rufen Sie die Dokumentation zum Apigee-Portal auf.