Swagger
Le connecteur Swagger prend en charge un fichier Swagger avec les types d'authentification suivants : de base, OAuth et clé d'application. Ce connecteur prend en charge les spécifications
OpenAPI 2.0 et
OpenAPI 3.0.
Disponibilité du connecteur
Le connecteur Swagger est disponible depuis la version 8.4.3.
Action prise en charge
Déclencheurs pris en charge
Aucun
Autorisations prises en charge
Le connecteur Swagger prend en charge l'autorisation suivante :
• Aucun
• Base
• OAuth
 |
• Clé application
Autoriser Swagger
Une autorisation Swagger est nécessaire pour chaque action du connecteur Swagger. Dans la liste de schémas d'authentification, sélectionnez un des schémas d'autorisation :
• Aucun : indiquez l'URL du fichier Swagger, par exemple https://petstore.swagger.io/v2/swagger.json
• Base : pour ajouter une connexion de base, procédez comme suit :
1. Dans la liste de schémas d'authentification, sélectionnez Base.
2. Dans le champ Swagger Connection, cliquez sur Ajouter nouveau.
3. Dans la fenêtre Ajouter connexion, spécifiez ce qui suit :
▪ Etiquette de connexion : automatiquement définie. Vous pouvez modifier l'étiquette de connexion à votre convenance.
|
|
Les noms d'étiquette sont sensibles à la casse. Ils ne peuvent pas contenir d'espaces, n'acceptent pas certains caractères spéciaux et ne doivent pas commencer par un chiffre.
|
▪ URL Swagger : URL du fichier Swagger.json.
▪ Nom d'utilisateur : nom d'utilisateur pour l'application cible.
▪ Mot de passe : mot de passe pour l'application cible.
4. Cliquez sur AJOUTER. Une nouvelle autorisation est ajoutée à la liste.
• OAuth : pour ajouter une connexion OAuth, procédez comme suit :
Prérequis : avant d'ajouter une nouvelle connexion OAuth, assurez-vous de suivre la procédure indiquée à la section Swagger de la rubrique
Configuration des paramètres OAuth des connecteurs.
1. Dans la liste des schémas d'authentification, sélectionnez OAuth.
2. Dans le champ OAuth Swagger, cliquez sur Add new Swagger login.
3. Dans la fenêtre Paramètres, entrez la valeur Swagger URL, puis cliquez sur AUTORISER. La fenêtre Ajouter autorisation s'ouvre.
4. Dans la fenêtre Ajouter autorisation, modifiez l'Etiquette d'autorisation, si nécessaire, puis entrez l'URL de la ressource.
5. Cliquez sur AJOUTER.
• Clé application : pour ajouter une nouvelle connexion par clé d'application, procédez comme suit :
1. Dans la liste des schémas d'authentification, sélectionnez Clé application.
2. Dans le champ Swagger AppKey, cliquez sur Ajouter nouveau.
3. Dans la fenêtre Ajouter connexion, spécifiez ce qui suit :
▪ Etiquette de connexion : automatiquement définie. Vous pouvez modifier l'étiquette de connexion à votre convenance.
|
|
Les noms d'étiquette sont sensibles à la casse. Ils ne peuvent pas contenir d'espaces, n'acceptent pas certains caractères spéciaux et ne doivent pas commencer par un chiffre.
|
▪ URL Swagger : URL du fichier Swagger.json, par ex. https://petstore.swagger.io/v2/swagger.json.
▪ Clé application : entrez la clé d'application Swagger.
4. Cliquez sur AJOUTER.
|
|
Cliquez sur TESTER pour valider l'autorisation.
|
Limitations du connecteur Swagger
• Dans la spécification OpenAPI 3.0, le champ du serveur offre la possibilité de définir plusieurs URL de base. L'implémentation actuelle ne prend pas en charge cette option, mais la première URL de base est extraite du tableau de serveurs.
• Les types de média suivants sont autorisés dans la demande : application/json et application/x-www-form-urlencoded. Les caractères génériques ne sont pas autorisés. Pour la réponse, application/JSON est autorisé.
• Le chargement et le téléchargement de fichiers ou d'images ne sont pas pris en charge.
• Les données de type multipart/form-data ne sont pas prises en charge.
• La méthode de sérialisation des paramètres est définie par défaut pour tous les paramètres.
• L'utilisation de "one of", "anyOf", "allOf" et "not" n'est pas prise en charge dans le champ de type.
• L'authentification multiple n'est pas autorisée. Toutes les API doivent avoir une authentification similaire.