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:

API-Proxy aus einer Spezifikation erstellen
API-Produkt erstellen
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.

Um einen API-Proxy aus einer OpenAPI-Spezifikation zu erstellen:

Wählen Sie in der Apigee-Benutzeroberfläche in der linken Navigationsleiste Entwickeln > API-Proxys aus, um die Seite "API-Proxys" zu öffnen.
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.
Klicken Sie unter Reverse-Proxy (am häufigsten) auf OpenAPI-Spezifikation verwenden.

Das Dialogfeld OpenAPI-Spezifikation verwenden wird angezeigt.

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

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.
Bearbeiten Sie das Feld Beschreibung so: API-Proxy für Hello World.
Klicken Sie auf Weiter.
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.
Klicken Sie auf Weiter.
Prüfen Sie auf der Seite Abläufe, ob alle Vorgänge ausgewählt sind, und klicken Sie auf Weiter.
Wählen Sie auf der Seite Zusammenfassung unter Optionale Bereitstellung die Umgebung aus, in der Sie die Bereitstellung vornehmen möchten.
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.

API-Produkt erstellen:

Wählen Sie in der Apigee-Benutzeroberfläche in der linken Navigationsleiste Veröffentlichen > API-Produkte aus, um die Seite "API-Produkte" zu öffnen.
Klicken Sie auf +Erstellen.
Die Seite „Produkt“ 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]

Klicken Sie unter Vorgänge auf Vorgang hinzufügen, um die Vorgänge auszuwählen, die dem API-Produkt hinzugefügt werden sollen.
Klicken Sie unter Quelle auf API-Proxy und wählen Sie 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.
Klicken Sie auf Speichern, um den Vorgang zu speichern.
Das Dialogfeld Vorgang hinzufügen wird angezeigt.
Klicken Sie auf Hinzufügen.
Klicken Sie auf 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:

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.
Klicken Sie auf + (Pluszeichen).
Wählen Sie Hello World im Dialogfeld API-Produkt zum Katalog hinzufügen aus und klicken Sie auf Weiter.
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.
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.
Klicken Sie auf Speichern.

So rufen Sie die API-Referenzdokumentation auf:

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

Mock Target API im Bereich „Diese API testen“ veröffentlicht