Essayez l’API!
La fonctionnalité ESSAYEZ ! vous permet de tester votre API directement dans votre navigateur. Elle fonctionne aussi bien sur un portail de documentation publié que directement dans l’éditeur.
Comment configurer
La fonctionnalité Essayez‑le ! utilise le fetch API, donc pour qu’elle fonctionne, vos imports d’API doivent inclure les éléments suivants :
- un URL de chemin absolu vers votre API (pas seulement un chemin)
- ajoutez dans votre fichier .yml un URL comme suit
- servers :
- exemple d’URL : https://petstore3.swagger.io/api/v3 (votre URL réelle)
- les méthodes d’autorisation seront lues à partir de votre fichier API et incluses dans chaque page d’API
- CORS désactivé ou activé pour le domaine de documentation, afin que les utilisateurs puissent réellement tester votre API
Comment cela fonctionne
Importez vos fichiers API (importation directe ou synchronisation github)
[Optionnel] Définissez les valeurs « par défaut » dans votre fichier OpenAPI. De cette manière, lorsque vous importez votre API, toutes les valeurs « par défaut » seront ajoutées à l’exemple de code et vous pourrez tester votre API immédiatement sans devoir ajouter manuellement des valeurs aux paramètres.
Configurez la méthode API avec les paramètres de test
Après que vous mettez à jour les paramètres, l’exemple de code à droite (ou en dessous, selon la configuration de votre vue) se mettra également à jour avec les paramètres de test que vous avez ajoutés, vous fournissant l’extrait de code de la requête dans plusieurs langages.
Cliquez sur le bouton Essayez‑le ! et vérifiez la zone de réponse, sous l’exemple de code
