Skip to main content

Swagger OpenAPI für den Import vorbereiten

Sie können Swagger OpenAPI-Inhalte als json- oder yaml-Dateien importieren. Bevor Sie Ihre Inhalte in Paligo importieren können, muss das Projekt vorbereitet werden.

Wenn der Import abgeschlossen ist, erscheinen die Swagger OpenAPI-Inhalte als Topics im Content Manager. Mit Paligo können Sie die Topics auf Wunsch bearbeiten oder inhaltlich ergänzen. Beachten Sie, dass es auch eine Publikation gibt, die Links zu den Topics enthält. Die Publikation fungiert als Inhaltsverzeichnis für Ihre OpenAPI-Inhalte und legt die Struktur der Dokumentation fest. Sie können in Paligo zusätzliche Topics erstellen und zu den aus Ihrer OpenAPI importierten Inhalten hinzufügen sowie diese in die restliche in Paligo erstellte Softwaredokumentation integrieren.

Am besten verwenden Sie für die Veröffentlichung das HTML5-API-Layout von Paligo, da dieses Layout das Codebeispiel-Panel und den Hauptinhalt bereitstellt. Erfahren Sie mehr über den Inhalte veröffentlichen.

Wichtig

Wenn Ihre OpenAPI-Inhalte Überkreuzverweise enthalten, müssen Sie sie im json-Format importieren. Die yaml-Importfunktion unterstützt keine Überkreuzverweise.

So importieren Sie json- oder yaml-Inhalte in Paligo:

  1. Erstellen Sie eine ZIP-Datei, die die von Paligo zu importierende json- oder yaml-Datei enthält.

  2. Importassistenten verwenden Sie können den ,um Ihre Inhalte zu importieren. Wählen Sie Swagger OpenAPI als Importart aus.

Tipp

Wenn Sie noch kein OpenAPI-Projekt haben, können Sie dieses Beispiel verwenden, um den Import zu testen:  https://paligo.zendesk.com/hc/en-us/articles/360007352034-Download-API-Sample-Content. Es soll als Paligo Export File (PEF) importiert werden.