Redocly

Redocly est une plateforme de documentation API qui vous aide à créer des portails développeurs professionnels. Vous commencez avec un fichier OpenAPI qui décrit votre API, et Redocly le transforme en une documentation claire et lisible avec des exemples et des fonctionnalités interactives.

La plateforme comprend plusieurs produits qui fonctionnent ensemble. Reunite est l’endroit où les équipes rédigent et révisent le contenu. Realm délivre la documentation finale à vos utilisateurs. Redoc est le moteur open-source qui génère les documents de référence API. Reef vous aide à organiser et découvrir toutes vos APIs dans un seul catalogue.

Contrairement aux générateurs de documentation basiques, Redocly vous offre un portail développeur complet. Vous pouvez ajouter des guides, des tutoriels et des pages personnalisées en plus de votre référence API. Tout est versionné et se met à jour automatiquement lorsque vous modifiez la définition de votre API.

Commencer avec Redocly est simple. Voici les étapes pour créer votre documentation :

• Inscrivez-vous pour un compte Redocly et démarrez votre essai gratuit sur leur site web.

• Connectez votre dépôt de code depuis GitHub, GitLab ou Azure DevOps pour synchroniser automatiquement vos fichiers OpenAPI.

• Téléchargez ou liez votre fichier de définition OpenAPI. Redocly prend en charge les versions OpenAPI 2.0, 3.0 et 3.1.

• Personnalisez l'apparence en modifiant les couleurs, les polices et en ajoutant votre logo pour correspondre à votre marque.

• Ajoutez des pages de contenu supplémentaires en utilisant Markdown pour des guides, tutoriels et sections de démarrage.

• Utilisez l'éditeur intégré pour écrire et prévisualiser les modifications avant de les publier à votre audience.

• Configurez des builds automatiques pour que la documentation se mette à jour chaque fois que vous modifiez la définition de votre API dans votre dépôt.

• Configurez votre domaine personnalisé pour héberger la documentation sous votre propre adresse web.

• Documentation API automatique à partir de fichiers OpenAPI

• Beau layout à trois panneaux avec navigation et exemples

• Console API interactive pour tester les points de terminaison

• Options de personnalisation de la marque et du style

• Flux de travail Git avec mises à jour automatiques

• Support API multi-version

• Recherche avancée avec capacités IA

• Support Markdown pour guides et tutoriels

• Outils de collaboration et de revue en équipe

• Hébergement de domaine personnalisé inclus