Validieren der OpenAPI -YAML-Quelle

Vorgehensweise zum Validieren der OpenAPI -YAML-Quelle anhand von Swagger-Spezifikationen beim Bearbeiten einer API.

Informationen zu dieser Task

Wenn Sie eine API im API-Editor konfigurieren, können Sie die OpenAPI -YAML-Quelle validieren, indem Sie auf Validieren > Mit Spezifikationenklicken. Wenn Validierungsfehler des Swagger-Parsers gefunden werden, wird ein Fehlersymbol angezeigt, auf das Sie klicken können, um die einzelnen Fehler anzuzeigen und wo sie in der YAML auftreten. Anschließend können Sie die Fehler beheben, die Updates speichern und die YAML-Datei OpenAPI während des gesamten API-Konfigurationsprozesses validieren.
Hinweis:
  • Die Validierung von OpenAPI zeigt keine Gateway-oder Richtlinienfehler an, die das Staging oder die Veröffentlichung Ihrer API verhindern. Diese Art der Validierung erfolgt nur, wenn Sie versuchen, Ihre API bereitzustellen oder zu veröffentlichen. Weitere Informationen finden Sie unter API bereitstellen oder API veröffentlichen.
  • Sie können Ihr API-Dokument auch mithilfe von Governance -Regelsätzen validieren. Weitere Informationen finden Sie unter API oder Produktdokument mithilfe des Governance-Service validieren.

Sie können diese Task entweder mithilfe der UI-Anwendung API Designer oder mithilfe der browserbasierten Benutzerschnittstelle von API Manager ausführen.

Vorgehensweise

Führen Sie die folgenden Schritte aus, um die YAML-Quelle für OpenAPI zu validieren:

  1. Öffnen Sie die erforderliche API zur Bearbeitung, wie in Bearbeiten einer OpenAPI 2.0 -API-Definition oder Bearbeiten einer OpenAPI 3.0 -API-Definitionbeschrieben.
  2. Klicken Sie in der Menüleiste der Kopfzeile auf Validieren > Mit Spezifikationen .
    Screenshot der Menüleiste der Kopfzeile mit dem Schieberegler "Online", der Schaltfläche "Validieren" und der Schaltfläche "Speichern".
  3. Wenn Gültigkeitsfehler des Swagger-Parsers gefunden werden, wird in der Menüleiste des Headers ein Fehlersymbol angezeigt, wobei neben dem Symbol die Anzahl der gefundenen OpenAPI -Fehler angezeigt wird.
    Beispiel: Kleines, kreisförmiges, rotes Fehlersymbol, neben dem sich die Nummer eins befindet..
  4. Sie können dann auf das Fehlersymbol klicken, um eine detaillierte Liste der Fehler und ihre Position in der YAML anzuzeigen. Wenn Sie sich in der Ansicht Formular Formularsymbol befinden, können Sie auf einen einzelnen Fehler klicken, um direkt zum relevanten API-Abschnitt im Formular zu navigieren.
  5. Klicken Sie nach der Behebung des Fehlers auf Speichern , um Ihre Aktualisierungen zu speichern. Klicken Sie dann erneut auf Validieren .
  6. Wenn alle Fehler behoben sind, gibt die Validierung eine Erfolgsnachricht zurück.
    Beispiel: Screenshot eines kleinen, grünen Kreises, der ein schwarzes Häkchen enthält, neben dem Wort-API wurde validiert..