Paramètres OpenAPI
Les paramètres OpenAPI sont l’endroit où vous pouvez configurer votre fichier OpenAPI importé.
Comment accéder aux paramètres OpenAPI
Accédez à l’Espace et cliquez sur les 3 points ⫶
Cliquez maintenant sur Paramètres de l’API ouverte
Général
L’onglet Général des paramètres OpenAPI vous permet de :
- Activer/désactiver la fonctionnalité API Essayez‑le! (par défaut, cette fonctionnalité est activée)
- Afficher le lien de téléchargement Open API
- Créer une catégorie de modèles
- Rédiger une introduction API
Synchroniser manuellement
L’onglet Synchroniser manuellement vous permet de mettre à jour manuellement votre fichier API.
Vous pouvez soit l’ajouter à partir de votre stockage local, soit fournir une URL vers votre fichier et Archbee le mettra à jour.
Synchroniser via API
La synchronisation via API vous permet d’utiliser notre API publique pour synchroniser le fichier OpenAPI.
C’est un outil puissant puisqu’il vous permet de l’intégrer à votre CI/CD et d’effectuer des mises à jour automatiques selon votre processus de développement/déploiement.
Exemples de langages
À partir du changement de langage, vous pouvez modifier le langage de programmation dans lequel l’exemple de code est affiché.
Chaque fichier OpenAPI importé possède soit sur le côté droit soit en dessous un tiroir de code qui contient l’exemple de code de la requête API.
Par défaut, cet exemple de code est affiché dans 4 langages de programmation :
- cURL
- JS
- Python
- Ruby
Dans le menu Changement de langage, vous pouvez mettre à jour ces paramètres et voici comment :
Ouvrez l’onglet Exemple de langue
Pour ajouter une nouvelle langue sélectionnez-la simplement dans le menu déroulant, ou pour retirer une langue cliquez simplement sur le bouton « X » à proximité;
Fermez le menu et vérifiez le tiroir de code et les exemples de code mis à jour
