Afficher les documents de l'API dans différents modes

APIGit

2022-11-15

APIGit offre une expérience flexible et conviviale pour visualiser les documents de l'API. Vous pouvez facilement basculer entre différentes visionneuses pour afficher le même document sous différents angles, ce qui vous permet de mieux comprendre l'API et ses fonctionnalités. La visionneuse par défaut est construite à l'aide de la visionneuse Redoc open source populaire, qui offre une présentation attrayante et simple qui facilite la navigation et la compréhension de la documentation de l'API.

API main

La visionneuse Swagger est une option classique et facile à utiliser pour visualiser les documents de l'API. Il offre une mise en page simple et épurée qui permet une navigation claire et efficace. De plus, cette visionneuse est optimisée pour les performances, ce qui en fait un choix idéal pour les documents d'API volumineux ou complexes. Il fournit une manière traditionnelle de comprendre et de naviguer dans la documentation de l'API qui est simple et facile à comprendre.

swagger UI

La visionneuse de code offre une vue brute et non formatée d'un document d'API, offrant aux utilisateurs un aperçu détaillé de la structure sous-jacente et du format du document. Cette visionneuse est particulièrement utile pour déboguer les erreurs, car elle permet aux utilisateurs de voir le code exact et le formatage utilisés dans l'API. De plus, pour les experts en développement d'API, la visionneuse de code peut être un moyen efficace de modifier des documents d'API, offrant un accès facile au code sous-jacent. Cette visionneuse est le meilleur choix pour les développeurs et les experts qui souhaitent comprendre la documentation de l'API de manière plus technique et y apporter des modifications.

Code viewer

La visionneuse Diff permet aux utilisateurs de comparer deux documents d'API différents au sein d'un référentiel. Cette fonctionnalité est particulièrement utile pour les intégrations tierces, car elle permet d'examiner et de comprendre facilement toutes les modifications apportées aux documents d'API générés automatiquement. Cela permet de comparer les modifications apportées au document API et de mieux comprendre les mises à jour. C'est un excellent outil pour examiner les mises à jour, fusionner les modifications et assurer la cohérence des documents de l'API.

diff viewer