Produkt
API-Dokument
APIGit bietet benutzerfreundliche API-Dokumente mit schönen Themen und verschiedenen Ansichtsmodi. Sie können ein API-Dokument von jedem Punkt im API-Repository-Verlauf aus veröffentlichen und so sicherstellen, dass Sie immer Zugriff auf die neueste Version Ihrer Dokumentation haben. Darüber hinaus können Sie Ihre eigene Domain auf die veröffentlichten Dokumente verweisen, um sie im Stil Ihrer Marke zu präsentieren. Es macht es einfach, Ihre API-Dokumentation mit internen Teams und externen Partnern zu teilen, während ein konsistentes und professionelles Erscheinungsbild beibehalten wird.
Elegante und übersichtliche API-Dokumente
Ein veröffentlichtes API-Dokument besteht aus zwei Komponenten: API-Spezifikationen und Markdown-Dokumente, die beide aus den Dateien im API-Repository stammen. Sie können mehrere API-Dokumente als unterschiedliche Versionen veröffentlichen und einfach zwischen ihnen wechseln.
Ansichtsmodus der API-Spezifikationen - Standard
API-Spezifikationsdokumente können in verschiedenen Modi angezeigt werden und bieten ein umfassendes Verständnis der API. Zu den unterstützten Modi gehören: Standardansicht, Swagger-UI und Rohcodemodus. Auf diese Weise können Sie die API-Dokumentation so anzeigen und damit interagieren, wie es Ihren Anforderungen am besten entspricht.
Ansichtsmodus der API-Spezifikationen – Swagger-UI-Modus
Im Swagger-UI-Modus können Sie die API-Dokumentation im traditionellen Swagger-Design anzeigen, das eine vertraute und benutzerfreundliche Oberfläche zum Verständnis und zur Interaktion mit der API bietet.
Ansichtsmodus der API-Spezifikationen - Codemodus
Im Codemodus können Sie die rohen API-Spezifikationsdateien anzeigen, die einen direkten Zugriff auf den zugrunde liegenden Code bieten, sodass Sie ihn leicht überprüfen und bei Bedarf ändern können.
Markdown-Dokumente
Markdown-Dokumente sind auch in den veröffentlichten API-Dokumenten enthalten. Sie bieten einen idealen Ort, um Ihre Designkonzepte und die Geschäftslogik hinter den APIs zu präsentieren. Darüber hinaus unterstützen wir auch den Standard- und Codemodus für Markdown-Dokumente, mit denen Sie die Dokumente so anzeigen und überprüfen können, wie es Ihren Anforderungen am besten entspricht.
Benutzerdefinierten Domain
Sobald Sie eine benutzerdefinierte Domäne eingerichtet haben, können Sie einen CNAME-Eintrag verwenden, um Ihre eigene Domäne auf Ihre veröffentlichten Dokumente zu verweisen, sodass Sie sie unter Ihrem eigenen Markennamen und Ihrer eigenen URL anzeigen können.
© 2024 APIGit Inc.