APIs veröffentlichen (Originalversion)

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

Veröffentlichen Sie APIs in Ihrem Portal, um sie App-Entwicklern zur Verfügung zu stellen, wie in den folgenden Abschnitten beschrieben.

API-Veröffentlichung

Die Veröffentlichung von APIs in Ihrem Portal erfolgt in zwei Schritten:

1. Wählen Sie das API-Produkt aus, das Sie in Ihrem Portal veröffentlichen möchten.
2. Es wird eine automatische API-Referenzdokumentation aus einem Snapshot Ihrer OpenAPI-Spezifikation generiert, damit App-Entwickler mehr über Ihre APIs erfahren können. Weitere Informationen zu Snapshots finden Sie unter Was ist ein Snapshot einer OpenAPI-Spezifikation?

Wenn Sie eine API in Ihrem Portal veröffentlichen, werden die folgenden Aktualisierungen automatisch am Portal vorgenommen:

• Ihrem Portal wird eine API-Referenzseite hinzugefügt
  Auf der API-Referenzseite wird die API-Referenzdokumentation angezeigt, die Sie automatisch aus einem Snapshot Ihrer OpenAPI-Spezifikation generieren. Entwickler können in Ihrer API-Dokumentation auf Jetzt testen klicken, um eine API-Anfrage zu senden und sich die Ausgabe anzusehen.

  Hinweis: Sie können den Inhalt dieser Seite nicht direkt bearbeiten. Er wird nicht in der Seitenliste in Ihrem Portal angezeigt.

  

• Auf der Seite „APIs“ wird ein Link zur API-Referenzseite hinzugefügt.
  Die API-Seite, die im Beispielportal enthalten ist, enthält eine Liste aller in Ihrem Portal veröffentlichten APIs mit Links zur entsprechenden API-Referenzdokumentation für weitere Informationen.

  Hinweis: Sie können den Inhalt dieser Seite nicht direkt bearbeiten. Er wird nicht in der Seitenliste in Ihrem Portal angezeigt.

  

Was ist ein Snapshot einer OpenAPI-Spezifikation?

Jede OpenAPI-Spezifikation dient als „Source of Truth“ für den gesamten Lebenszyklus einer API. Die gleiche Spezifikation wird in jeder Phase des API-Lebenszyklus verwendet, von der Entwicklung über die Veröffentlichung bis hin zum Monitoring. Wenn Sie eine Spezifikation ändern, müssen Sie wissen, welche Auswirkungen die Änderungen auf Ihre API durch andere Lebenszyklusphasen haben, wie unter Was passiert, wenn ich eine Spezifikation ändere? beschrieben.

Beim Veröffentlichen der API erstellen Sie einen Snapshot der OpenAPI-Spezifikation, um die API-Referenzdokumentation zu generieren. Dieser Snapshot repräsentiert eine bestimmte Version der Spezifikation im Spezifikationsspeicher. Wenn Sie die OpenAPI-Spezifikation mithilfe des Spezifikationseditors ändern, können Sie einen weiteren Snapshot der Spezifikation erstellen, um die neuesten Änderungen in der API-Referenzdokumentation widerzuspiegeln.

API-Proxys CORS-Unterstützung hinzufügen

Bevor Sie Ihre APIs veröffentlichen, müssen Sie Ihren API-Proxys die CORS-Unterstützung hinzufügen, um clientseitige ursprungsübergreifende Anfragen zu unterstützen.

CORS (Cross-Origin Resource Sharing) ist ein Standardmechanismus, der es ermöglicht, dass auf einer Webseite ausgeführte JavaScript XMLHttpRequest-Aufrufe (XHR) mit Ressourcen von Nicht-Ursprungsdomains interagieren können. CORS ist eine häufig implementierte Lösung für die Same-Origin-Richtlinie, die von allen Browsern durchgesetzt wird. Wenn Sie beispielsweise einen XHR-Aufruf an die Twitter API von JavaScript-Code ausführen, der in Ihrem Browser ausgeführt wird, schlägt der Aufruf fehl. Das liegt daran, dass die Domain, über die die Seite für Ihren Browser bereitgestellt wird, nicht mit der Domain identisch ist, über die die Twitter API bereitgestellt wird. CORS bietet eine Lösung für dieses Problem, da Server sich für Cross-Origin Resource Sharing aktivieren lassen können.

Informationen zum Hinzufügen der CORS-Unterstützung zu Ihren API-Proxys vor dem Veröffentlichen der APIs finden Sie unter CORS-Unterstützung zu einem API-Proxy hinzufügen.

Hinweis: Die meisten modernen Browser erzwingen CORS. Hier finden Sie eine umfassende Liste der unterstützten Browser. Eine ausführliche Beschreibung von CORS finden Sie in der Cross-Origin Resource Sharing-W3C-Empfehlung.

Seite „APIs“ ansehen

So greifen Sie auf die Seite „APIs“ zu:

1. Wählen Sie Veröffentlichen > Portale und anschließend dein Portal aus.
2. Klicken Sie auf der Startseite des Portals auf APIs.

Alternativ können Sie APIs im Drop-down-Menü des Portals in der oberen Navigationsleiste auswählen.

Die Liste der APIs wird angezeigt.

Wie in der vorherigen Abbildung hervorgehoben, können Sie auf der Seite „APIs“ Folgendes tun:

• Details der auf Ihrem Portal verfügbaren APIs ansehen
• API zum Portal hinzufügen
• Erstellen Sie einen Snapshot der OpenAPI-Spezifikation, die mit einem API-Produkt verknüpft ist, um die API-Referenzdokumentation zu aktualisieren
• API im Portal veröffentlichen oder Veröffentlichung aufheben
• Zielgruppe für eine API im Portal verwalten
• Bearbeiten Sie die zugehörige Spezifikation (siehe Spezifikationen mit dem Spezifikationseditor erstellen).
• API aus dem Portal entfernen
• Identifizieren Sie schnell „verwaiste“ APIs, deren zugehöriges API-Produkt von Edge entfernt wurde, und erstellen Sie das API-Produkt neu oder löschen Sie die API aus Ihrem Portal

API zum Portal hinzufügen

Hinweis: Sie können Ihrem Portal maximal 100 APIs hinzufügen.

So fügen Sie Ihrem Portal eine API hinzu:

1. Wählen Sie Veröffentlichen > Portale und anschließend dein Portal aus.
2. Klicken Sie auf der Startseite des Portals auf APIs.
   Alternativ können Sie in der oberen Navigationsleiste im Drop-down-Menü des Portals APIs auswählen.
3. Klicken Sie auf + API.
   Das Dialogfeld „API-Produkt zum Portal hinzufügen“ wird angezeigt.

4. Wählen Sie im Dialogfeld auf dem Tab „API-Produkt“ das API-Produkt aus, das Sie zu Ihrem Portal hinzufügen möchten.
   

5. Klicken Sie auf Weiter.

6. Wählen Sie die Quelle für den Snapshot aus.
   Wenn Sie den im API-Produkt enthaltenen API-Proxy mithilfe einer OpenAPI-Spezifikation erstellt haben, wählen Sie die Spezifikation aus der Drop-down-Liste aus.
   

   Alternativ können Sie auch Folgendes auswählen:

   • Keine Spezifikation und fügen Sie später eine hinzu, nachdem die API veröffentlicht wurde, wie unter Snapshot der Spezifikation erstellen beschrieben.
   • Wählen Sie eine andere Spezifikation aus, um eine neue Spezifikation auszuwählen oder hochzuladen.

7. Klicken Sie das Kästchen Veröffentlicht an, um die API im Portal zu veröffentlichen. Heben Sie die Auswahl von Veröffentlicht auf, wenn Sie die API noch nicht veröffentlichen möchten.
   Sie können die Einstellung später ändern, wie unter API im Portal veröffentlichen oder die Veröffentlichung einer API aufheben beschrieben.

8. Wählen Sie unter „Zielgruppe“ eine der folgenden Optionen aus, um die Zielgruppe für Ihre API zu verwalten, indem Sie Zugriff auf Folgendes gewähren:

   • Anonyme Nutzer, um allen Nutzern die Anzeige der Seite zu ermöglichen.
   • Registrierte Nutzer, um nur registrierten Nutzern die Anzeige der Seite zu ermöglichen.

   Sie können die Einstellung später ändern, wie unter Zielgruppe für eine API im Portal verwalten beschrieben.

9. Klicken Sie auf Fertig.

Snapshot der Spezifikation erstellen

Nachdem Sie Ihre API veröffentlicht haben, können Sie jederzeit einen neuen Screenshot der OpenAPI-Spezifikation erstellen, um die auf Ihrem Portal veröffentlichte API-Referenzdokumentation zu aktualisieren.

So erstellen Sie einen Snapshot der OpenAPI-Spezifikation:

1. Wählen Sie Veröffentlichen > Portale und anschließend dein Portal aus.
2. Klicken Sie auf der Startseite des Portals auf APIs.
   Alternativ können Sie in der oberen Navigationsleiste im Drop-down-Menü des Portals APIs auswählen.
3. Platzieren Sie den Cursor auf der API, für die Sie einen Snapshot erstellen möchten, um die Aktionen anzuzeigen.

4. Klicken Sie auf .

   Hinweis: Wenn Ihr Snapshot mit der ausgewählten Quellspezifikation aktuell ist, wird eine Meldung angezeigt.

5. Wählen Sie im Drop-down-Menü „Snapshot-Quelle“ eine vorhandene Spezifikation aus oder klicken Sie auf Andere Spezifikation auswählen, um eine neue Spezifikation zum Generieren der Dokumentation für die API auszuwählen oder hochzuladen. Alternativ können Sie Keine Spezifikation auswählen, um die aktuelle Spezifikation zu entfernen.

6. Klicken Sie auf Snapshot aktualisieren (oder Snapshot entfernen, wenn Sie "Keine Spezifikationen" ausgewählt haben).

Die API-Referenzdokumentation wird aus der Spezifikation generiert und der API-Referenzseite hinzugefügt.

API im Portal veröffentlichen oder Veröffentlichung aufheben

So veröffentlichen Sie eine API auf Ihrem Portal oder heben die Veröffentlichung auf:

1. Wählen Sie Veröffentlichen > Portale und anschließend dein Portal aus.
2. Klicken Sie auf der Startseite des Portals auf APIs.
   Alternativ können Sie in der oberen Navigationsleiste im Drop-down-Menü des Portals APIs auswählen.
3. Positionieren Sie den Cursor über der API, die Sie veröffentlichen oder deren Veröffentlichung Sie aufheben möchten.
4. Klicken Sie auf .
5. Klicken Sie das Kästchen Aktiviert an, um die API im Portal zu veröffentlichen. Heben Sie die Auswahl von Aktiviert auf, um die Veröffentlichung der API aufzuheben.
6. Klicken Sie auf Speichern.

Zielgruppe für eine API im Portal verwalten

Verwalten Sie die Zielgruppe für Ihre API auf Ihrem Portal, indem Sie Zugriff auf Folgendes gewähren:

• Alle Nutzer
• Nur registrierte Nutzer

So verwalten Sie die Zielgruppe für eine API auf Ihrem Portal:

1. Wählen Sie Veröffentlichen > Portale und anschließend dein Portal aus.
2. Klicken Sie auf der Startseite des Portals auf APIs.
   Alternativ können Sie in der oberen Navigationsleiste im Drop-down-Menü des Portals APIs auswählen.
3. Platzieren Sie den Cursor auf der API, für die Sie die Zielgruppe verwalten möchten, um die Aktionen anzuzeigen.
4. Klicken Sie auf .
5. Wählen Sie unter „Zielgruppe“ eine der folgenden Optionen aus:
   • Anonyme Nutzer, damit alle Nutzer das API-Produkt sehen können
   • Registrierte Nutzer, um nur registrierten Nutzern den Zugriff auf das API-Produkt zu gewähren.
6. Klicken Sie auf Speichern.

API aus dem Portal entfernen

So entfernen Sie eine API aus dem Portal:

1. Wählen Sie Veröffentlichen > Portale und anschließend dein Portal aus.
2. Klicken Sie auf der Startseite des Portals auf APIs.
   Alternativ können Sie in der oberen Navigationsleiste im Drop-down-Menü des Portals APIs auswählen.
3. Bewegen Sie den Mauszeiger in der Liste auf die API, um das Aktionsmenü einzublenden.
4. Klicken Sie auf .

Probleme mit veröffentlichten APIs beheben

Wenn bei der Verwendung von „Ausprobieren“ der Fehler TypeError: Failed to fetch zurückgegeben wird, sollten Sie die folgenden möglichen Ursachen und Lösungen berücksichtigen:

• Fehler aufgrund gemischter Inhalte werden möglicherweise durch ein bekanntes Problem mit der Swagger UI verursacht. Sie können das Problem möglicherweise umgehen, wenn Sie HTTPS in der Definition schemes Ihrer OpenAPI-Spezifikation vor HTTP angeben. Beispiel:

   schemes:
     - https
     - http
  

• Bei CORS-Einschränkungsfehlern (Cross-Origin Resource Sharing) müssen Sie dafür sorgen, dass CORS für Ihre API-Proxys unterstützt wird. CORS ist ein Standardmechanismus, der clientseitige Cross-Origin-Anfragen ermöglicht. Weitere Informationen finden Sie unter CORS-Unterstützung für einen API-Proxy hinzufügen. Stellen Sie außerdem sicher, dass CORS in Ihrem Browser aktiviert ist.