Spezifikationen mit dem Spezifikationseditor erstellen

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

Mit dem Spezifikationseditor können Sie OpenAPI-Spezifikationen erstellen und validieren, ohne Code schreiben zu müssen.

Spezifikationseditor aufrufen

Öffnen Sie eine OpenAPI-Spezifikation im Spezifikationseditor, wie in den folgenden Abschnitten beschrieben:

Die folgende Abbildung zeigt die Spezifikation für die Petstore API, die im Spezifikationseditor geöffnet ist:

Wie in der vorherigen Abbildung hervorgehoben, können Sie mit dem Spezifikationseditor Folgendes tun:

  • Erstellen Sie Ihre OpenAPI-Spezifikation, um die API im linken Bereich im JSON- oder YAML-Format zu modellieren.
  • Sehen Sie sich im rechten Bereich die automatisch generierte API-Dokumentation an.
  • Überprüfen Sie Ihre Spezifikation während der Eingabe anhand des OpenAPI-Spezifikationsstandards.
  • Speichern Sie die OpenAPI-Spezifikation oder schließen Sie die Spezifikation und brechen Sie Ihre Änderungen ab.

Hilfe zu JSON und YAML

JSON (JavaScript Object Notation) ist ein einfaches Datenaustauschformat zur Darstellung einfacher Datenstrukturen und assoziativer Arrays. Weitere Informationen finden Sie unter https://www.json.org.

YAML (YAML Ain't Markup Language) ist ein Standard zur Datenserialisierung/Darstellung mit einer Syntax, die auch Datenstrukturen wie Listen, assoziativen Arrays und Skalaren zugeordnet werden kann. Weitere Informationen finden Sie unter https://yaml.org.

Sowohl JSON als auch YAML sind maschinenlesbar, aber auch für Menschen leicht zu lesen und zu verstehen. In der folgenden Abbildung werden zwei kurze Auszüge aus derselben OpenAPI-Spezifikation in JSON und YAML verglichen:

JSON und YAML im Vergleich

Spezifikation validieren

Der Spezifikationseditor validiert Ihre OpenAPI-Spezifikation anhand des OpenAPI-Spezifikationsstandards. Wenn Ihre OpenAPI-Spezifikation Fehler enthält, zeigt der Spezifikationseditor während der Eingabe oben rechts das Dialogfeld „Fehler“ an. Es enthält weitere Informationen zu den Fehlern und den zugehörigen Zeilennummern, sodass Sie diese einfach korrigieren können.

Fehler

Spezifikation speichern

Klicken Sie zum Speichern einer OpenAPI-Spezifikation in der oberen Navigationsleiste auf Speichern.

Wenn Sie die Spezifikation zum ersten Mal speichern, werden Sie zur Eingabe eines Dateinamens aufgefordert. Wenn Sie keinen Dateinamen angeben, wird standardmäßig Unbenannt verwendet. Sie können sie später umbenennen.

Spezifikation schließen

Wenn Sie eine OpenAPI-Spezifikation schließen möchten, ohne Ihre Änderungen zu speichern, klicken Sie in der oberen Navigationsleiste auf Abbrechen. Sie werden zur Spezifikationsliste zurückgeleitet.