APIs veröffentlichen

Sie sehen sich die Dokumentation zu Apigee Edge an.
Gehen Sie 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. Rendern Sie die API-Referenzdokumentation aus einem Snapshot Ihres OpenAPI-Dokuments oder eines GraphQL-Schemas, damit App-Entwickler Informationen zu Ihren APIs erhalten können. Weitere Informationen zu Snapshots finden Sie unter Was ist ein Snapshot?

Was wird im Portal veröffentlicht?

Wenn Sie eine API veröffentlichen, werden die folgenden Aktualisierungen automatisch an Ihrem Portal vorgenommen:
  • API-Referenzdokumentation. Welche Schnittstelle bereitgestellt wird hängt davon ab, ob Sie Ihre API mit einem OpenAPI-Dokument oder einem GraphQL-Schema veröffentlichen. Siehe:
  • Der Seite „APIs“ wird ein Link zur API-Referenzseite hinzugefügt.

    Die Seite „APIs“ (im Beispielportal enthalten) umfasst eine Liste aller in Ihrem Portal veröffentlichten APIs in alphabetischer Reihenfolge. Auch Links zu den entsprechenden API-Referenzdokumenten, wo Sie weitere Informationen enthalten, sind dort zu finden. Sie können Folgendes nach Bedarf anpassen:

    • Das für jede API-Karte angezeigte Bild
    • Kategorien zum Taggen von APIs, damit Entwickler auf der Seite „APIs“ ähnliche APIs finden können

    Grafik: Seite „APIs“ im Live-Portal mit zwei Kategorien und verwendeten Bildern

    • SmartDocs (OpenAPI)

    Wenn Sie eine API mit einem OpenAPI-Dokument veröffentlichen, wird die SmartDocs API-Referenzdokumentation Ihrem Portal hinzugefügt.

    Entwickler können die Referenzdokumentation der SmartDocs API aufrufen und im Bereich API testen eine API-Anfrage stellen und die Ausgabe ansehen. Testen Sie, ob diese API mit ungesicherten Endpunkten oder sicheren Endpunkten entsprechend der in Ihrem OpenAPI-Dokument festgelegten Sicherheitsmethode mit der grundlegenden API-Schlüsselvalidierung oder der OAuth-Authentifizierung funktioniert. Bei OAuth werden folgende Abläufe unterstützt: Autorisierungscode, Passwort und Clientanmeldedaten.

    Grafik: Seite der API-Referenzdokumentation mit Zusatzinformationen, die Aufschluss darüber geben, wie Sie den API-Aufruf autorisieren, das Feld „API testen“ abkoppeln, die relevante Spezifikation herunterladen und die API ausführen

    Klicken Sie auf , um das Feld „API testen“ zu maximieren. Im maximierten Steuerfeld können Sie die curl-Aufrufe und Codebeispiele in verschiedenen Formaten ansehen, z. B. HTTP, Python, Node.js usw. (siehe unten).

    Grafik: Maximiert das Feld „API testen“

    GraphQL Explorer

    Wenn Sie eine API mithilfe eines GraphQL-Schemas veröffentlichen, wird der GraphQL-Explorer Ihrem Portal hinzugefügt. Der GraphQL Explorer ist ein interaktiver Playground zum Ausführen von Abfragen für Ihre API. Der Explorer basiert auf GraphiQL, einer von der GraphQL Foundation entwickelten Referenzimplementierung der GraphQL-IDE.

    Entwickler können mit GraphQL Explorer die schemabasierte interaktive Dokumentation entdecken, Abfragen erstellen und ausführen, Abfrageergebnisse ansehen und das Schema herunterladen. Um den Zugriff auf Ihre API zu sichern, können Entwickler Autorisierungsheader im Bereich Anfrageheader übergeben.

    Weitere Informationen zu GraphQL finden Sie unter graphql.org.

    GraphQL Explorer im Portal

    Was ist ein Snapshot?

    Jedes OpenAPI- oder GraphQL-Dokument dient über den gesamten Lebenszyklus einer API als Quelle der Wahrheit. Die gleiche Dokument wird in jeder Phase des API-Lebenszyklus verwendet, von der Entwicklung über die Veröffentlichung bis hin zum Monitoring. Wenn Sie ein Dokument ändern, müssen Sie wissen, welche Auswirkungen die Änderungen auf Ihre API durch andere Lebenszyklusphasen haben, wie unter Was passiert, wenn ich ein Dokument ändere? beschrieben.

    Wenn Sie Ihre API veröffentlichen, erstellen Sie einen Snapshot des OpenAPI- oder GraphQL-Dokuments, um die API-Referenzdokumentation zu rendern. Dieser Snapshot repräsentiert eine bestimmte Version des Dokuments. Wenn Sie das Dokument ändern, können Sie einen weiteren Snapshot des Dokuments erstellen, um die neuesten Änderungen in der API-Referenzdokumentation widerzuspiegeln.

    Über Callback-URLs

    Wenn Ihre Anwendungen eine Callback-URL erfordern, z. B. bei Verwendung des Grant-Typs des OAuth 2.0-Autorisierungscodes (auch als „Dreibeiniges OAuth“ bezeichnet), können Sie festlegen, dass Entwickler bei der Registrierung ihrer Anwendung eine Callback-URL angeben müssen. Die Callback-URL gibt normalerweise die URL einer Anwendung an, die einen Autorisierungscode im Namen der Clientanwendung erhalten soll. Weitere Informationen finden Sie unter Grant-Typ des Autorisierungscodes implementieren.

    Sie können konfigurieren, ob beim Hinzufügen einer API zu Ihrem Portal eine Callback-URL bei der Anwendungsregistrierung erforderlich ist. Sie können diese Einstellung jederzeit ändern, wie unter Callback-URL für eine API verwalten beschrieben.

    Entwickler müssen bei der Registrierung einer Anwendung eine Callback-URL für alle APIs eingeben, die sie benötigen, wie unter Anwendungen registrieren beschrieben.

    API-Proxy für die Unterstützung von „API testen“ konfigurieren

    Bevor Sie Ihre APIs mit einem OpenAPI-Dokument veröffentlichen, müssen Sie Ihren API-Proxy für die Unterstützung von Anfragen im Bereich "Diese API testen“ in der Referenzdokumentation der SmartDocs API folgendermaßen konfigurieren:

    • Fügen Sie Ihren API-Proxys CORS-Unterstützung hinzu, um clientseitige ursprungsübergreifende Anfragen zu erzwingen

      CORS ist ein Standardmechanismus, mit dem JavaScript XMLHttpRequest-Aufrufe (XHR), die auf einer Webseite ausgeführt werden, mit Ressourcen von Nicht-Origin-Domains interagieren können. CORS ist eine häufig implementierte Lösung der Same-Origin-Richtlinie, die von allen Browsern durchgesetzt wird.

    • Aktualisieren Sie die API-Proxykonfiguration, wenn Sie eine Basisauthentifizierung oder OAuth2 verwenden

    In der folgenden Tabelle sind die Anforderungen für die API-Proxy-Konfiguration zusammengefasst, um das Feld „API testen“ in der Referenzdokumentation der SmartDocs API basierend auf dem Authentifizierungszugriff zu unterstützen.

    Auth-Zugriff Anforderungen an die Richtlinienkonfiguration
    Keine oder API-Schlüssel Fügen Sie Ihrem API-Proxy eine CORS-Unterstützung hinzu. Verwenden Sie die CORS-Beispiellösung aus GitHub oder folgen Sie der Anleitung unter CORS-Unterstützung zu einem API-Proxy hinzufügen.
    Basisauthentifizierung Führen Sie folgende Schritte aus:
    1. Fügen Sie Ihrem API-Proxy eine CORS-Unterstützung hinzu. Verwenden Sie die CORS-Beispiellösung aus GitHub oder folgen Sie der Anleitung unter CORS-Unterstützung zu einem API-Proxy hinzufügen.
    2. Stellen Sie in der Richtlinie "CORS-Zuweisungsmeldung hinzufügen" sicher, dass der Header Access-Control-Allow-Headers das Attribut authorization enthält. Beispiel:
      <Header name="Access-Control-Allow-Headers">
  origin, x-requested-with, accept, content-type, authorization
</Header>
      .
    OAuth2
    1. Fügen Sie Ihrem API-Proxy eine CORS-Unterstützung hinzu. Verwenden Sie die CORS-Beispiellösung aus GitHub oder folgen Sie der Anleitung unter CORS-Unterstützung zu einem API-Proxy hinzufügen.
    2. Stellen Sie in der Richtlinie "CORS-Zuweisungsmeldung hinzufügen" sicher, dass der Header Access-Control-Allow-Headers das Attribut authorization enthält. Beispiel:
      <Header name="Access-Control-Allow-Headers">
  origin, x-requested-with, accept, content-type, authorization
</Header>
      .
    3. Korrigieren Sie das nicht RFC-konforme Verhalten in der OAuth2-Richtlinie. Verwenden Sie die OAuth2-Beispiellösung aus GitHub oder gehen Sie folgendermaßen vor:
      • Das Element <GrantType> in der OAuth2-Richtlinie muss auf request.formparam.grant_type (Formparameter) gesetzt sein. Weitere Informationen finden Sie unter <GrantType>.
      • token_type in der OAuth2-Richtlinie muss auf Bearer und nicht auf die Standardeinstellung BearerToken gesetzt sein.

    API-Katalog ansehen

    So rufen Sie den API-Katalog auf: 1. Wählen Sie Veröffentlichen > Portale und anschließend dein Portal aus. 2. Klicken Sie auf der Startseite des Portals auf API-Katalog. Alternativ können Sie im Drop-down-Menü des Portals in der oberen Navigationsleiste die Option API-Katalog auswählen.

    Auf dem Tab APIs im API-Katalog wird eine Liste der APIs angezeigt, die Ihrem Portal hinzugefügt wurden.

    Grafik: Tab „APIs“ mit Informationen zu den APIs, einschließlich Name, Beschreibung, Sichtbarkeit, Kategorien, zugehöriger Spezifikation und geänderter Zeit

    Wie bereits erwähnt, können Sie auf dem Tab „APIs“:

    API zu Ihrem Portal hinzufügen

    So fügen Sie Ihrem Portal eine API hinzu:

    1. Rufen Sie den API-Katalog auf.
    2. Klicken Sie auf den Tab APIs, falls er nicht bereits ausgewählt ist.

    3. Klicken Sie auf + (Pluszeichen).

      Das Dialogfeld „API-Produkt zum Katalog hinzufügen“ wird angezeigt.

    4. Wählen Sie das API-Produkt aus, das Sie dem Portal hinzufügen möchten.

    5. Klicken Sie auf Weiter. Die Seite mit den API-Details wird angezeigt.

    6. Konfigurieren Sie den Inhalt der API-Referenzdokumentation und seine Sichtbarkeit im Portal:

      Feld Beschreibung
      VeröffentlichtWählen Sie Veröffentlicht aus, um die API in Ihrem Portal zu veröffentlichen. Entfernen Sie das Häkchen aus dem Kästchen, wenn Sie die API nicht veröffentlichen möchten. Sie können die Einstellung später ändern, wie unter API auf Ihrem Portal veröffentlichen oder Veröffentlichung aufheben beschrieben.
      Anzeigename Aktualisieren Sie den Titel Ihrer API, der im Katalog angezeigt wird. Standardmäßig wird der API-Produktname verwendet. Sie können den Titel später ändern. Weitere Informationen dazu finden Sie unter Angezeigten Titel und Beschreibung bearbeiten.
      Angezeigte Beschreibung Aktualisieren Sie die im Katalog angezeigte Beschreibung der API Standardmäßig wird die API-Produktbeschreibung verwendet. Sie können die Anzeigebeschreibung später ändern, wie unter Angezeigten Titel und Beschreibung bearbeiten beschrieben.
      Entwickler müssen eine Callback-URL angebenAktivieren Sie diese Option, wenn App-Entwickler eine Callback-URL angeben sollen. Sie können die Callback-URL später hinzufügen oder aktualisieren, wie in Callback-URL für eine API verwalten beschrieben.
      API-Dokumentation So verwenden Sie ein OpenAPI-Dokument:
      1. Wählen Sie OpenAPI-Dokument aus.
      2. Klicken Sie auf Dokument auswählen.
      3. Führen Sie einen der folgenden Schritte aus:
        • Klicken Sie auf den Tab My Specs (Meine Spezifikationen) und wählen Sie eine Spezifikation aus dem Spezifikationsspeicher aus.
        • Klicken Sie auf den Tab Datei hochladen und laden Sie eine Datei hoch.
        • Klicken Sie auf den Tab Aus einer URL importieren und importieren Sie eine Spezifikation von einer URL.
      4. Klicken Sie auf Auswählen.

      So verwenden Sie ein GraphQL-Schema:

      1. Wählen Sie GraphQL-Schema.
      2. Klicken Sie auf Dokument auswählen.
      3. Rufen Sie das GraphQL-Schema auf und wählen Sie es aus.
      4. Klicken Sie auf Auswählen.

      Alternativ können Sie Keine Dokumentation auswählen und später eine anfügen, nachdem die API hinzugefügt wurde, wie unter Snapshot eines Dokuments verwalten beschrieben.

      API-Sichtbarkeit

      Wenn Sie sich noch nicht für die Betaversion des Features zur Zielgruppenverwaltung angemeldet haben, wählen Sie eine der folgenden Optionen aus:

      • Anonyme Nutzer, damit alle Nutzer die API sehen können.
      • Registrierte Nutzer, um nur registrierten Nutzern Zugriff auf die API zu gewähren.

      Wenn Sie sich für die Betaversion der Funktion „Zielgruppenverwaltung“ angemeldet haben, wählen Sie eine der folgenden Optionen aus:

      • Öffentlich (für alle sichtbar), damit alle Nutzer die API aufrufen können.
      • Authentifizierte Nutzer, um nur authentifiziertem Nutzern Zugriff auf die API zu gewähren.
      • Ausgewählte Zielgruppen, um die spezifischen Zielgruppen auszuwählen, die in der Lage sein sollen, die API aufzurufen.

      Sie können die Zielgruppensichtbarkeit später verwalten, wie unter Sichtbarkeit einer API im Portal verwalten beschrieben.

      Bild anzeigen Wenn auf der Seite „APIs“ ein Bild auf der API-Karte angezeigt werden soll, klicken Sie auf Bild auswählen. Wählen Sie im Dialogfeld Bild auswählen ein vorhandenes Bild aus, laden Sie ein neues Bild hoch oder geben Sie die URL eines externen Bilds an und klicken Sie auf Auswählen. Sehen Sie sich eine Vorschau der API-Miniaturansicht an und klicken Sie auf Auswählen. Sie können später ein Bild hinzufügen, wie unter Bild für eine API-Karte verwalten beschrieben. Wenn Sie ein Bild mit einer externen URL angeben, wird das Bild nicht in Ihre Assets hochgeladen. Außerdem hängt das Laden des Images im integrierten Portal von seiner Verfügbarkeit ab, die durch Content Security Policy blockiert oder eingeschränkt sein kann.
      Kategorien

      Fügen Sie die Kategorien hinzu, für die die API getaggt wird, damit App-Entwickler auf der Seite „APIs“ ähnliche APIs finden können. So bestimmen Sie eine Kategorie:

      • Wählen Sie eine Kategorie aus der Drop-down-Liste aus.
      • Fügen Sie eine neue Kategorie hinzu, indem Sie ihre Bezeichnung eingeben und die Eingabetaste drücken. Die neue Kategorie wird der Seite „Kategorien“ hinzugefügt und bereitgestellt, sobald Sie weitere APIs hinzufügen oder bearbeiten.

    7. Klicken Sie auf Speichern.

    Snapshot des Dokuments verwalten

    Nach dem Veröffentlichen Ihrer API können Sie jederzeit einen neuen Snapshot des OpenAPI-Dokuments erstellen, um die API-Referenzdokumentation zu aktualisieren, die auf dem Portal veröffentlicht wurde.

    So verwalten Sie den Snapshot des Dokuments:

    1. Rufen Sie den API-Katalog auf.
    2. Klicken Sie auf den Tab APIs, falls er nicht bereits ausgewählt ist.
    3. Klicken Sie auf die Zeile der API, die Sie bearbeiten möchten.
    4. Prüfen Sie den Snapshot-Status. Wenn sie veraltet ist, wird die folgende Meldung angezeigt: Grafik: Symbol und Nachricht mit veraltetem Snapshot
    5. Klicken Sie auf Symbol &quot;Bearbeiten&quot;.
    6. Führen Sie eine der folgenden Aufgaben aus:
      • Klicken Sie zum Aktualisieren des Snapshots eines veralteten OpenAPI-Dokuments auf Snapshot aktualisieren.
      • Wenn Sie das Dokument ändern möchten, das zum Generieren der Dokumentation für die API verwendet wird, klicken Sie unter „API-Dokumentation“ auf Dokument auswählen und wählen Sie das neue Dokument aus.
    7. Klicken Sie auf Speichern.

    Die API-Referenzdokumentation wird aus dem Dokument gerendert und der API-Referenzseite hinzugefügt. Der Snapshot-Status wird auf den neuesten Stand gebracht:

    Grafik: Symbol und Nachricht geben an, dass der Snapshot aktuell ist

    API auf dem Portal veröffentlichen oder Veröffentlichung aufheben

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

    1. Rufen Sie den API-Katalog auf.
    2. Klicken Sie auf den Tab APIs, falls er nicht bereits ausgewählt ist.
    3. Klicken Sie auf die Zeile der API, die Sie bearbeiten möchten.
    4. Klicken Sie auf Symbol &quot;Bearbeiten&quot;.
    5. Wählen Sie in den API-Details die Option Veröffentlicht (im Katalog aufgeführt) aus oder heben Sie die Auswahl auf, um die API auf Ihrem Portal zu veröffentlichen bzw. ihre Veröffentlichung rückgängig zu machen.
    6. Klicken Sie auf Speichern.

    Sichtbarkeit einer API in Ihrem Portal verwalten

    Verwalten Sie die Sichtbarkeit einer API in Ihrem Portal durch Gewähren des Zugriffs für:

    So verwalten Sie die Sichtbarkeit einer API in Ihrem Portal:

    1. Rufen Sie den API-Katalog auf.
    2. Klicken Sie auf den Tab APIs, falls er nicht bereits ausgewählt ist.
    3. Klicken Sie auf die Zeile der API, die Sie bearbeiten möchten.
    4. Klicken Sie auf Symbol &quot;Bearbeiten&quot;.
    5. Wählen Sie unter „API-Sichtbarkeit“ eine der folgenden Optionen aus:

    6. Wählen Sie die Sichtbarkeitseinstellung aus. Wenn Sie sich für die Betaversion des Zielgruppen-Features angemeldet haben, wählen Sie eine der folgenden Optionen aus:

      • Öffentlich (für alle sichtbar), damit alle Nutzer die Seite aufrufen können.
      • Authentifizierte Nutzer, um nur registrierten Nutzern die Anzeige der Seite zu ermöglichen.
      • Ausgewählte Zielgruppen, damit nur von Ihnen festgelegte Zielgruppen die Seite aufrufen können. Weitere Informationen finden Sie unter Zielgruppen für Ihr Portal verwalten.
      Wählen Sie anderenfalls eine der folgenden Optionen aus:
      • 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.

    7. Klicken Sie auf Senden.

    Callback-URL für eine API verwalten

    Callback-URL für eine API verwalten Weitere Informationen finden Sie unter Callback-URLs.

    So verwalten Sie die Callback-URL für eine API:

    1. Rufen Sie den API-Katalog auf.
    2. Klicken Sie auf den Tab APIs, falls er nicht bereits ausgewählt ist.
    3. Klicken Sie auf die Zeile der API, die Sie bearbeiten möchten.
    4. Klicken Sie auf Symbol &quot;Bearbeiten&quot;.
    5. Wählen Sie in den API-Details die Option Veröffentlicht (im Katalog aufgeführt) aus oder heben Sie die Auswahl auf, um die API auf Ihrem Portal zu veröffentlichen bzw. ihre Veröffentlichung rückgängig zu machen.
    6. Klicken Sie auf Speichern.

    Bild für eine API-Karte verwalten

    Verwalten Sie das Bild, das mit einer API-Karte auf der Seite „APIs“ angezeigt wird, indem Sie das aktuelle Bild hinzufügen oder ändern.

    So verwalten Sie das Bild für eine API-Karte:

    1. Rufen Sie den API-Katalog auf.
    2. Klicken Sie auf den Tab APIs, falls er nicht bereits ausgewählt ist.
    3. Klicken Sie auf die Zeile der API, die Sie bearbeiten möchten.
    4. Klicken Sie auf Symbol &quot;Bearbeiten&quot;.

    5. Gehen Sie unter API-Details folgendermaßen vor:

      • Klicken Sie auf Bild auswählen, um ein Bild anzugeben oder hochzuladen, falls derzeit keins ausgewählt ist.
      • Klicken Sie auf Bild ändern, um ein anderes Bild anzugeben oder hochzuladen.
      • Klicken Sie im Bild auf x, um es zu entfernen.

      Geben Sie beim Angeben eines Bildes entweder ein Bild mit einer externen URL an, die für das Katalogelement verwendet wird, oder einen Dateipfad für im Portal gespeicherte Bilddateien. Beispiel: /files/book-tree.jpg Wenn Sie die URL eines externen Bilds angeben, wird das Bild nicht in Ihre Assets hochgeladen. Darüber hinaus hängt das Laden des Bildes im integrierten Portal von dessen Verfügbarkeit ab. Diese kann durch Inhaltssicherheitsrichtlinien blockiert oder eingeschränkt werden.

    6. Klicken Sie auf Speichern.

    API mithilfe von Kategorien taggen

    Gehen Sie folgendermaßen vor, um eine API mithilfe von Kategorien zu taggen:

    • Verwalten Sie beim Bearbeiten der API wie unten beschrieben die Kategorien, mit denen eine API getaggt wird.
    • Verwalten Sie die durch eine Kategorie getaggten APIs beim Bearbeiten der Kategorie.

    So versehen Sie eine API mit Kategorien, wenn Sie die API bearbeiten:

    1. Rufen Sie den API-Katalog auf.
    2. Klicken Sie auf den Tab APIs, falls er nicht bereits ausgewählt ist.
    3. Klicken Sie auf die Zeile der API, die Sie bearbeiten möchten.
    4. Klicken Sie auf Symbol &quot;Bearbeiten&quot;.
    5. Klicken Sie auf das Feld Kategorien und führen Sie einen der folgenden Schritte aus:
      • Wählen Sie eine Kategorie aus der Drop-down-Liste aus.
      • Fügen Sie eine neue Kategorie hinzu, indem Sie ihre Bezeichnung eingeben und die Eingabetaste drücken. Die neue Kategorie wird der Seite „Kategorien“ hinzugefügt und bereitgestellt, sobald Sie weitere APIs hinzufügen oder bearbeiten.
    6. Wiederholen Sie diese Schritte, um die API mehreren Kategorien zuzuordnen.
    7. Klicken Sie auf Speichern.

    Angezeigten Titel und Beschreibung bearbeiten

    So bearbeiten Sie den angezeigten Titel und die Beschreibung:

    1. Rufen Sie den API-Katalog auf.
    2. Klicken Sie auf den Tab APIs, falls er nicht bereits ausgewählt ist.
    3. Klicken Sie auf die Zeile der API, die Sie bearbeiten möchten.
    4. Klicken Sie auf Symbol &quot;Bearbeiten&quot;.
    5. Bearbeiten Sie nach Bedarf die Felder Titel anzeigen und Beschreibung anzeigen.
    6. Klicken Sie auf Speichern.

    API aus dem Portal entfernen

    So entfernen Sie eine API aus dem Portal:

    1. Rufen Sie den API-Katalog auf.
    2. Wählen Sie die APIs aus, falls Sie diese nicht bereits ausgewählt haben.
    3. Bewegen Sie den Mauszeiger in der Liste auf die API, um das Aktionsmenü einzublenden.
    4. Klicken Sie auf Symbol &quot;Bearbeiten&quot;.

    Kategorien verwalten, mit denen zugehörige APIs gefunden werden

    Taggen Sie die API mithilfe von Kategorien, damit App-Entwickler ähnliche APIs auf der API-Seite des Live-Portals finden können. Fügen Sie Kategorien hinzu und verwalten Sie sie, wie in den folgenden Abschnitten beschrieben.

    Die Seite „Kategorien“ kennenlernen

    So rufen Sie die Seite „Kategorien“ auf:

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

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

    3. Klicken Sie auf den Tab Kategorien.

    Auf dem Tab Kategorien im API-Katalog wird die Liste der Kategorien angezeigt, die für Ihr Portal festgelegt wurden.

    Grafik: Tab „Kategorien“ mit dem Namen der Kategorie sowie den Namen und der Gesamtzahl der zugewiesenen APIs

    Wie bereits erwähnt, können Sie auf der Seite „APIs“ Folgendes tun:

    Kategorie hinzufügen

    Eine Kategorie können Sie folgendermaßen hinzuzufügen:

    Die neue Kategorie wird der Seite „Kategorien“ hinzugefügt und bereitgestellt, sobald Sie weitere APIs hinzufügen oder bearbeiten.

    So fügen Sie eine Kategorie manuell hinzu:

    1. Rufen Sie die Seite „Kategorien“ auf.
    2. Klicken Sie auf + (Pluszeichen).
    3. Geben Sie den Namen Ihrer neuen Kategorie ein.
    4. Optional können Sie eine oder mehrere APIs auswählen, die mit der Kategorie versehen werden sollen.
    5. Klicken Sie auf Erstellen.

    Kategorie bearbeiten

    So bearbeiten Sie eine Kategorie:

    1. Rufen Sie die Seite „Kategorien“ auf.
    2. Klicken Sie auf .
    3. Bearbeiten Sie den Namen der Kategorie.
    4. Fügen Sie API-Tags hinzu oder entfernen Sie sie.
    5. Klicken Sie auf Speichern.

    Kategorie löschen

    Wenn Sie eine Kategorie löschen, werden auch alle API-Tags für diese Kategorie gelöscht.

    So löschen Sie eine Kategorie:

    1. Rufen Sie die Seite „Kategorien“ auf.
    2. Bewegen Sie den Mauszeiger auf die Kategorie, die Sie bearbeiten möchten, damit das Aktionsmenü eingeblendet wird.
    3. Klicken Sie auf .
    4. Bearbeiten Sie den Namen der Kategorie.
    5. Fügen Sie APIs hinzu oder entfernen Sie sie.
    6. Klicken Sie auf Speichern.

    Probleme mit veröffentlichten APIs beheben

    In den folgenden Abschnitte erfahren Sie, wie Sie bestimmter Fehler bei unseren veröffentlichten APIs beheben.

    Fehler: Abrufen des Fehlers bei Verwendung dieser API fehlgeschlagen

    Wenn bei „API testen“ der Fehler TypeError: Failed to fetch zurückgegeben wird, kann das folgende Ursachen haben:

    • 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 in der schemes-Definition Ihres OpenAPI-Dokuments HTTPS vor HTTP angeben. Beispiel:

      schemes:
   - https
   - http

    • Prüfen Sie bei Fehlern aufgrund von CORS-Einschränkungen (Cross-Origin Resource Sharing), ob Ihre API-Proxys CORS unterstützen. CORS ist ein Standardmechanismus, der clientseitige Cross-Origin-Anfragen ermöglicht. Siehe API-Proxy für die Unterstützung von "API testen" konfigurieren.

    Fehler: "Access-Control-Allow-Origin"-Header enthält mehrere Werte "*, *" aber nur ein Wert ist zulässig

    Bei der Verwendung von „API testen“ erhalten Sie möglicherweise die folgende Fehlermeldung, wenn der Header Access-Control-Allow-Origin bereits vorhanden ist:

    The 'Access-Control-Allow-Origin' header contains multiple values '*, *', but only one is allowed.

    Ändern Sie zur Behebung dieses Fehlers wie im Auszug dargestellt die zu verwendende AssignMessage-Richtlinie so, dass <Set> zur Festlegung der CORS-Header verwendet wird und nicht <Add>. Weitere Informationen finden Sie im entsprechenden Community-Artikel. 

    <AssignMessage async="false" continueOnError="false" enabled="true" name="add-cors">
    <DisplayName>Add CORS</DisplayName>
    <FaultRules/>
    <Properties/>
    <Set>
        <Headers>
            <Header name="Access-Control-Allow-Origin">{request.header.origin}</Header>
            <Header name="Access-Control-Allow-Headers">origin, x-requested-with, accept, content-type, authorization</Header>
            <Header name="Access-Control-Max-Age">3628800</Header>
            <Header name="Access-Control-Allow-Methods">GET, PUT, POST, DELETE</Header>
        </Headers>
    </Set>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="response"/>
</AssignMessage>

    Fehler: Anfrageheaderfeld nicht zulässig

    Wenn Sie bei Verwendung dieser API einen Request header field not allowed-Fehler wie im folgenden Beispiel erhalten, müssen Sie möglicherweise die in der CORS-Richtlinie unterstützten Header aktualisieren. Beispiel:

    Access to XMLHttpRequest ... has been blocked by CORS policy: Request header field
content-type is not allowed by Access-Control-Allow-Headers in preflight response

    In diesem Beispiel müssen Sie den Abschnitt content-type in den Abschnitt Access-Control-Allow-Headers der CORS-AssignMessage-Richtlinie einfügen, wie unter CORS-Richtlinie an einen neuen API-Proxy anhängen beschrieben.

    Fehler: Zugriff verweigert, wenn ein API-Proxy mit OAuth2 aufgerufen wird

    Die OAuthV2-Richtlinie von Apigee gibt eine Tokenantwort zurück, die bestimmte nicht RFC-konforme Attribute enthält. Die Richtlinie gibt beispielsweise ein Token mit dem Wert BearerToken anstelle des erwarteten RFC-konformen Werts Bearer zurück. Diese ungültige token_type-Antwort kann bei Verwendung von „API testen“ zu einem Access denied-Fehler führen.

    Zur Behebung dieses Problems können Sie eine JavaScript- oder AssignMessage-Richtlinie erstellen, um die Richtlinienausgabe in ein konformes Format umzuwandeln. Weitere Informationen finden Sie unter Nicht RFC-konformes Verhalten.