Sie lesen gerade die Dokumentation zu Apigee Edge.
Apigee X-Dokumentation aufrufen. info
Mit dem Spezifikationseditor können Sie OpenAPI-Spezifikationen erstellen und validieren, ohne Code schreiben zu müssen.
Auf den Spezifikationseditor zugreifen
Öffnen Sie eine OpenAPI-Spezifikation im Spezifikationseditor, wie in den folgenden Abschnitten beschrieben:
- Neue OpenAPI-Spezifikation erstellen
- OpenAPI-Spezifikation importieren
- Vorhandene OpenAPI-Spezifikation bearbeiten
In der folgenden Abbildung sehen Sie 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 im linken Bereich Ihre OpenAPI-Spezifikation, um Ihre API im JSON- oder YAML-Format zu modellieren.
- Im rechten Bereich wird automatisch generierte API-Dokumentation angezeigt.
- Validieren Sie Ihre Spezifikation während der Eingabe anhand des OpenAPI-Spezifikationsstandards.
- Speichern Sie Ihre OpenAPI-Spezifikation oder schließen Sie sie und brechen Sie Ihre Änderungen ab.
Hilfe bei JSON und YAML
JSON (JavaScript Object Notation) ist ein schlankes Format für den Datenaustausch, das zum Darstellen einfacher Datenstrukturen und assoziativer Arrays verwendet wird. Weitere Informationen finden Sie unter https://www.json.org.
YAML (YAML Ain't Markup Language) ist ein Standard für die Datenserialisierung/-darstellung, der eine Syntax bietet, die auch Datenstrukturen wie Listen, assoziative Arrays und Skalare zugeordnet werden kann. Weitere Informationen finden Sie unter https://yaml.org.
Sowohl JSON als auch YAML sind maschinenlesbar, aber auch für Menschen leicht lesbar und verständlich. In der folgenden Abbildung werden zwei kurze Auszüge aus derselben OpenAPI-Spezifikation verglichen, die mit JSON und YAML geschrieben wurden:
Spezifikation validieren
Der Spezifikationseditor validiert Ihre OpenAPI-Spezifikation anhand des OpenAPI-Spezifikationsstandards. Wenn Sie tippen und Fehler in Ihrer OpenAPI-Spezifikation vorhanden sind, wird im Spezifikationseditor oben im rechten Bereich das Dialogfeld „Fehler“ angezeigt. Dort finden Sie weitere Informationen zu den Fehlern und den zugehörigen Zeilennummern, damit Sie sie leicht korrigieren können.
Spezifikation speichern
Wenn Sie eine OpenAPI-Spezifikation speichern möchten, klicken Sie in der oberen Navigationsleiste auf Speichern.
Wenn Sie die Spezifikation zum ersten Mal speichern, werden Sie aufgefordert, einen Dateinamen einzugeben. 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.