Produit
Documents API
APIGit propose des documents d'API conviviaux et joliment thématiques avec différents modes d'affichage. Vous pouvez publier un document d'API à partir de n'importe quel point de l'historique du référentiel d'API, en vous assurant d'avoir toujours accès à la dernière version de votre documentation. De plus, vous pouvez également faire pointer votre propre domaine vers les documents publiés, ce qui vous permet de les présenter dans le style de votre marque. Il facilite le partage de la documentation de votre API avec des équipes internes et des partenaires externes, tout en conservant une apparence cohérente et professionnelle.
Documents API élégants et clairs
Un document d'API publié comprend deux composants : les spécifications d'API et les documents de démarquage, tous deux provenant des fichiers du référentiel d'API. Vous pouvez publier plusieurs documents d'API sous différentes versions et basculer facilement entre eux.
Mode d'affichage des spécifications de l'API - par défaut
Les documents de spécification de l'API peuvent être consultés dans différents modes, offrant une compréhension complète de l'API. Les modes pris en charge incluent : la vue par défaut, l'interface utilisateur swagger et le mode de code brut. Cela vous permet d'afficher et d'interagir avec la documentation de l'API de la manière qui répond le mieux à vos besoins.
Mode d'affichage des spécifications de l'API - mode d'interface utilisateur swagger
En mode Swagger UI, vous pouvez afficher la documentation de l'API dans le thème swagger traditionnel, offrant une interface familière et facile à utiliser pour comprendre et interagir avec l'API.
Mode d'affichage des spécifications de l'API - Mode code
En mode code, vous pouvez afficher les fichiers de spécification d'API bruts, offrant un accès direct au code sous-jacent, ce qui facilite la révision et les modifications si nécessaire.
Documents de démarquage
Les documents Markdown sont également inclus dans les documents API publiés. Ils constituent un emplacement idéal pour présenter vos concepts de conception et la logique métier derrière les API. De plus, nous prenons également en charge le mode par défaut et le mode code pour les documents Markdown, ce qui vous permet de visualiser et de réviser les documents de la manière qui répond le mieux à vos besoins.
Domaine personnalisé
Une fois que vous avez configuré un domaine personnalisé, vous pouvez utiliser un enregistrement CNAME pour faire pointer votre propre domaine vers vos documents publiés, ce qui vous permet de les afficher sous votre propre nom de marque et URL.
© 2024 APIGit Inc.