Zeigen Sie API-Dokumente in verschiedenen Modi an

APIGit

2022-11-15

APIGit bietet eine flexible und benutzerfreundliche Erfahrung zum Anzeigen von API-Dokumenten. Sie können einfach zwischen verschiedenen Viewern wechseln, um dasselbe Dokument aus verschiedenen Perspektiven anzuzeigen, wodurch Sie ein tieferes Verständnis der API und ihrer Funktionen erlangen können. Der Standard-Viewer basiert auf dem beliebten Open-Source-Redoc-Viewer, der ein attraktives und unkompliziertes Layout bietet, das die Navigation und das Verständnis der API-Dokumentation erleichtert.

API main

Der Swagger-Viewer ist eine klassische und einfach zu bedienende Option zur Visualisierung von API-Dokumenten. Es bietet ein einfaches, übersichtliches Layout, das eine klare und effiziente Navigation ermöglicht. Darüber hinaus ist dieser Viewer auf Leistung optimiert, was ihn zur idealen Wahl für große oder komplexe API-Dokumente macht. Es bietet eine traditionelle Möglichkeit, die API-Dokumentation zu verstehen und zu navigieren, die einfach und leicht verständlich ist.

swagger UI

Der Code-Viewer bietet eine rohe und unformatierte Ansicht eines API-Dokuments und bietet Benutzern einen detaillierten Einblick in die zugrunde liegende Struktur und das Format des Dokuments. Dieser Viewer ist besonders nützlich zum Debuggen von Fehlern, da Benutzer den genauen Code und die Formatierung sehen können, die in der API verwendet werden. Darüber hinaus kann der Code-Viewer für Experten in der API-Entwicklung eine effiziente Möglichkeit zum Bearbeiten von API-Dokumenten sein und einfachen Zugriff auf den zugrunde liegenden Code bieten. Dieser Viewer ist die beste Wahl für Entwickler und Experten, die die API-Dokumentation eher technisch verstehen und Änderungen daran vornehmen möchten.

Code viewer

Der Diff-Viewer ermöglicht es Benutzern, zwei verschiedene API-Dokumente innerhalb eines Repositorys zu vergleichen. Diese Funktion ist besonders nützlich für Integrationen von Drittanbietern, da sie eine einfache Überprüfung und ein besseres Verständnis aller Änderungen ermöglicht, die an automatisch generierten API-Dokumenten vorgenommen wurden. Es hilft, die im API-Dokument vorgenommenen Änderungen zu vergleichen und die Aktualisierungen besser zu verstehen. Es ist ein großartiges Tool zum Überprüfen von Updates, Zusammenführen von Änderungen und Sicherstellen der Konsistenz in den API-Dokumenten.

diff viewer