Spezifikationen verwalten

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

Apigee Edge bietet Ihnen einen Ort, an dem Sie Ihre OpenAPI-Spezifikationen speichern können. Verwalten Sie Ihre OpenAPI-Spezifikationen wie in den folgenden Abschnitten beschrieben.

Weitere Informationen zu OpenAPI-Spezifikationen finden Sie unter Was ist eine OpenAPI-Spezifikation?

Liste der Spezifikationen ansehen

So greifen Sie auf die Liste mit den Spezifikationen zu:

  1. Melden Sie sich unter apigee.com/edge an.
  2. Organisation auswählen.
  3. Wählen Sie im seitlichen Navigationsmenü Develop > Specs (Entwickeln > Spezifikationen) aus.

Die aktuelle Liste der Spezifikationen und Ordner wird angezeigt.

Liste der Spezifikationen

Wie in der vorherigen Abbildung hervorgehoben, können Sie in der Liste der Spezifikationen Folgendes tun:

Neue OpenAPI-Spezifikation erstellen

So erstellen Sie eine neue OpenAPI-Spezifikation:

  1. Klicken Sie in der seitlichen Navigationsleiste auf Entwickeln > Spezifikationen.
  2. Klicken Sie auf + Spec (+ Spezifikationen).
  3. Klicken Sie im Drop-down-Menü auf New Spec (Neue Spezifikation). Der Spezifikationseditor wird geöffnet.
  4. Ersetzen Sie die Beispielspezifikation durch Ihre eigenen OpenAPI-Spezifikationsdetails.
    Weitere Informationen finden Sie unter Spezifikationen mit dem Spezifikationseditor erstellen.
  5. Klicken Sie auf Speichern, um die Spezifikation zu speichern.
  6. Geben Sie bei Aufforderung einen Namen für die Spezifikation ein.
  7. Klicken Sie auf Speichern.

OpenAPI-Spezifikation importieren

So importieren Sie eine OpenAPI-Spezifikation:

  1. Klicken Sie in der seitlichen Navigationsleiste auf Entwickeln > Spezifikationen.
  2. Klicken Sie auf + Spec (+ Spezifikationen).
  3. Klicken Sie im Drop-down-Menü auf eine der folgenden Optionen:
    • Import URL (URL importieren), um die Spezifikation aus einer URL zu importieren. Geben Sie den Namen und die URL an, wenn Sie dazu aufgefordert werden.
    • Import file (Datei importieren), um Ihr lokales Verzeichnis nach der Spezifikation zu durchsuchen.
      Die Spezifikation wird der Liste hinzugefügt.
  4. Klicken Sie auf den Namen der Spezifikation, um sie im Spezifikationseditor aufzurufen und zu bearbeiten.
    Weitere Informationen finden Sie unter Spezifikationen mit dem Spezifikationseditor erstellen.

Vorhandene OpenAPI-Spezifikation bearbeiten

So öffnen Sie eine vorhandene OpenAPI-Spezifikation:

  1. Klicken Sie in der seitlichen Navigationsleiste auf Entwickeln > Spezifikationen.
  2. Klicken Sie in der Spezifikationsliste auf die Zeile, die mit der Spezifikation verknüpft ist.
  3. Bearbeiten Sie die Spezifikation im Spezifikationseditor.
    Weitere Informationen finden Sie unter Spezifikationen mit dem Spezifikationseditor erstellen.

API-Proxy aus einer Spezifikation in der Spezifikationsliste erstellen

Mit Apigee Edge können Sie Ihre API-Proxys aus den OpenAPI-Spezifikationen erstellen, die Sie im Spezifikationseditor entwerfen und speichern. Mit nur wenigen Klicks haben Sie einen API-Proxy in Apigee Edge mit den automatisch generierten Pfaden, Parametern, bedingten Abläufen und Zielendpunkten. Anschließend können Sie Funktionen wie OAuth-Sicherheit, Ratenbegrenzung und Caching hinzufügen.

Nachdem Sie einen API-Proxy aus einer OpenAPI-Spezifikation erstellt haben und die Spezifikation geändert wurde, müssen Sie den API-Proxy manuell ändern, um die implementierten Änderungen widerzuspiegeln. Weitere Informationen finden Sie unter Was passiert, wenn ich eine Spezifikation ändere?.

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

  1. Wählen Sie im seitlichen Navigationsmenü Develop > Specs (Entwickeln > Spezifikationen) aus.
  2. Rufen Sie gegebenenfalls den Ordner auf, der die OpenAPI-Spezifikation enthält.
  3. Platzieren Sie den Cursor auf der OpenAPI-Spezifikation, für die Sie einen API-Proxy erstellen möchten, um das Aktionsmenü anzuzeigen.
  4. Klicken Sie auf Proxy generieren. Der Assistent zum Erstellen von Proxys wird geöffnet und die Seite "Proxydetails" ist mit Werten aus der OpenAPI-Spezifikation vorgefüllt, wie in der folgenden Abbildung dargestellt.
    Proxy-Assistenten erstellen
  5. Klicken Sie auf Weiter.
  6. Befolgen Sie die übrigen Seiten im Assistenten zum Erstellen von Proxys, wie unter API-Proxy aus einer OpenAPI-Spezifikation erstellen beschrieben. Beginnen Sie mit Schritt 8.

Spezifikation umbenennen

So benennen Sie eine Spezifikation um:

  1. Wählen Sie im seitlichen Navigationsmenü Develop > Specs (Entwickeln > Spezifikationen) aus.
  2. Rufen Sie bei Bedarf den Ordner auf, der die Spezifikation enthält.
  3. Platzieren Sie den Cursor über der Spezifikation, die Sie umbenennen möchten, um das Aktionsmenü anzuzeigen.
  4. Klicken Sie auf Spezifikation umbenennen.
  5. Bearbeiten Sie den Namen der Spezifikation.
  6. Klicken Sie auf Umbenennen, um die Änderungen zu speichern, oder auf Abbrechen, um den Vorgang abzubrechen.

Spezifikation in einen Ordner verschieben

Sie können Ihre Spezifikationen in Ordnern organisieren, um die Verwaltung und Sicherheit zu vereinfachen. Informationen zum Verschieben einer Spezifikation in einen Ordner finden Sie unter Spezifikationen mithilfe von Ordnern organisieren.

Spezifikation löschen

Sie können eine Spezifikation aus dem Dateispeicher löschen, wenn sie nicht mehr benötigt wird oder ungültig wird.

So löschen Sie eine Spezifikation:

  1. Wählen Sie im seitlichen Navigationsmenü Develop > Specs (Entwickeln > Spezifikationen) aus.
  2. Platzieren Sie den Cursor über der Spezifikation, die Sie löschen möchten, um das Aktionsmenü anzuzeigen.
  3. Klicken Sie auf Symbol "Löschen".
  4. Klicken Sie in der Eingabeaufforderung auf Löschen, um den Löschvorgang zu bestätigen.
  5. Löschen Sie zugehörige Artefakte, die nicht mehr benötigt werden.