Spezifikationen verwalten

Sie sehen sich die Dokumentation zu Apigee Edge an.
Sehen Sie sich die Apigee X-Dokumentation an. info

In Apigee Edge können Sie Ihre OpenAPI-Spezifikationen speichern. 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 technischen Daten ansehen

So greifen Sie auf die Liste der technischen Daten zu:

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

Die aktuelle Liste der Spezifikationen und Ordner wird angezeigt.

Spezifikationsliste

Wie in der vorherigen Abbildung hervorgehoben, haben Sie in der Liste der Spezifikationen folgende Möglichkeiten:

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 + Spezifikation.
  3. Klicken Sie im Drop-down-Menü auf Neue Spezifikation. Der Spezifikationseditor wird geöffnet.
  4. Ersetzen Sie die Beispielspezifikation durch Ihre eigenen OpenAPI-Spezifikationsdetails.
    Weitere Informationen zum Erstellen von Spezifikationen mit dem Spezifikationseditor
  5. Klicken Sie auf Speichern, um die Spezifikation zu speichern.
  6. Geben Sie einen Namen für die Spezifikation ein, wenn Sie dazu aufgefordert werden.
  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 + Spezifikation.
  3. Klicken Sie im Drop-down-Menü auf eine der folgenden Optionen:
    • URL importieren, um die Spezifikation über eine URL zu importieren. Geben Sie den Namen und die URL an, wenn Sie dazu aufgefordert werden.
    • Klicken Sie auf Datei importieren, um in Ihrem lokalen Verzeichnis nach der Spezifikation zu suchen.
      Die Spezifikation wird der Liste hinzugefügt.
  4. Klicken Sie auf den Namen der Spezifikation, um sie im Spezifikationseditor aufzurufen und zu bearbeiten.
    Sehen Sie sich Spezifikationen mit dem Spezifikationseditor erstellen an.

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 Liste der Spezifikationen auf die Zeile, die mit der Spezifikation verknüpft ist.
  3. Bearbeiten Sie die Spezifikation im Spezifikationseditor.
    Weitere Informationen zum Erstellen von Spezifikationen mit dem Spezifikationseditor

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 erhalten Sie einen API-Proxy in Apigee Edge mit automatisch generierten Pfaden, Parametern, bedingten Abläufen und Zielendpunkten. Anschließend können Sie Funktionen wie OAuth-Sicherheit, Ratenbegrenzung und Caching hinzufügen.

Wenn Sie einen API-Proxy aus einer OpenAPI-Spezifikation erstellt haben und die Spezifikation geändert wird, müssen Sie den API-Proxy manuell ändern, um die implementierten Änderungen zu berücksichtigen. 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ü Entwickeln > Spezifikationen aus.
  2. Rufen Sie bei Bedarf den Ordner auf, der die OpenAPI-Spezifikation enthält.
  3. Bewegen Sie den Mauszeiger auf die OpenAPI-Spezifikation, für die Sie einen API-Proxy erstellen möchten, um das Aktionsmenü aufzurufen.
  4. Klicken Sie auf Proxy generieren. Der Assistent zum Erstellen von Proxy wird geöffnet und die Seite „Proxydetails“ enthält Werte aus der OpenAPI-Spezifikation, wie in der folgenden Abbildung dargestellt.
    Proxy-Erstellen-Assistent
  5. Klicken Sie auf Weiter.
  6. Gehen Sie die restlichen Seiten im Assistenten zum Erstellen von Proxys durch, 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ü Entwickeln > Spezifikationen aus.
  2. Rufen Sie bei Bedarf den Ordner mit der Spezifikation auf.
  3. Bewegen Sie den Mauszeiger auf die Spezifikation, die Sie umbenennen möchten, um das Aktionsmenü aufzurufen.
  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 sie zu verwerfen.

Spezifikation in einen Ordner verschieben

Sie können Ihre Spezifikationen in Ordnern organisieren, um die Verwaltung und Sicherheit zu erleichtern. 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ü Entwickeln > Spezifikationen aus.
  2. Bewegen Sie den Mauszeiger auf die Spezifikation, die Sie löschen möchten, um das Aktionsmenü aufzurufen.
  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.