Swagger OpenAPI importieren
Um Swagger Open API-Inhalte in Paligo zu verwenden, können Sie sie entweder einbetten oder Swagger OpenAPI importieren. Welcher Ansatz für Sie am besten geeignet ist, hängt von Ihren Anforderungen ab.
-
Der Import ist vorteilhaft, wenn Sie die Swagger Open API-Inhalte in Paligo formatieren müssen. Mit einem Import fügen Sie die Swagger Open API-Inhalte der Paligo-Datenbank hinzu, wo Sie die Formatierung genauer steuern können, genau wie bei regulären Paligo-Inhalten. Allerdings müssen Sie die Inhalte bei jeder Aktualisierung manuell importieren .
-
Die Einbettung ist vorteilhaft, wenn Ihre Swagger Open API-Inhalte an anderer Stelle im Internet, außerhalb von Paligo, vorhanden sind. Durch das Einbetten fügen Sie eine „Live“-Version der Inhalte zu einem Paligo Topic hinzu. Die Formatierung der Inhalte ist dann jedoch eingeschränkt, da sie sich nicht in der Paligo-Datenbank befinden und daher während der Veröffentlichung nicht von Paligo verarbeitet werden können.
In diesem Abschnitt erklären wir, wie Sie Swagger Open API-Inhalte importieren. Weitere Informationen zu ihrer Einbettung finden Sie unter Swagger OpenAPI einbetten.
Wenn Sie OpenAPI-Inhalte in Paligo importieren, existieren die Inhalte als Topics in Paligo und Sie können sie wie jedes andere Paligo Topic bearbeiten. Sie können die Inhalte importieren und sie dann je nach Bedarf entweder so veröffentlichen, wie sie sind, oder ihnen weitere Topics hinzufügen. Importierte OpenAPI-Inhalte funktionieren besonders gut mit dem HTML-API-Stil-Layout von Paligo, das ein Navigations-Panel, ein Inhalts-Panel und ein Beispielcode-Panel bietet, in dem Sie zwischen Codebeispielen in verschiedenen Programmiersprachen wechseln können.
 |