Étape OpenAPI/Postman
Importez la spécification OpenAPI ou une collection Postman d’un service Web REST sortant tiers et créez une intégration au service Web. Les détails de demande pour l’opération d’API REST sous-jacente sont dérivés de la spécification OpenAPI ou de la collection Postman.
Pour le corps de réponse de sortie JSON, le système crée une sortie d’objet de données complexe à partir de la spécification OpenAPI ou de la collection Postman.
Rôles et disponibilité
Disponible en tant qu’étape d’action du Concepteur d’action. Les utilisateurs disposant des rôles action_designer et open_api_admin ou administrateur peuvent créer une action personnalisée avec une ou plusieurs étapes d’action.
Champs
| Champ | Description |
|---|---|
| Alias de connexion | Enregistrement d’alias de connexion et d’informations d’identification que le système utilise pour exécuter l’étape d’action. Les utilisateurs disposant des rôles action_designer et connection_admin ou administrateur peuvent sélectionner un enregistrement d’alias de connexion associé. L’utilisation d’un alias élimine la nécessité de configurer plusieurs informations d’identification et profils d’informations de connexion lors de l’utilisation d’une action dans plusieurs environnements. De même, si les informations de connexion changent, vous n’avez pas besoin de mettre à jour votre action personnalisée. Pour en savoir plus sur les connexions et les informations d’identification, consultez Informations d’identification, connexions et alias. |
| URL de base | URL de base à partir de l’alias de connexion pour la demande REST. |
| Activer/désactiver la vue avancée | Option permettant d’afficher ou de masquer les détails de la demande. Lorsqu’elle est activée, vous pouvez afficher et configurer le chemin d’accès de la ressource, la méthode HTTP, les paramètres de requête, les en-têtes et les sorties d’action de la demande. |
| Source de l’API |
Option permettant de sélectionner une API dans la liste des API importées disponibles. |
| Importer spéc | Option qui vous permet d’importer une spécification OpenAPI (v2.0 ou v3.0) ou une collection Postman (version 2.0.0 ou 2.1.0). Vous pouvez importer une spécification OpenAPI ou une collection Postman en fournissant une URL et des informations d’identification à la spécification ou à la collection, ou en copiant-collant manuellement du contenu JSON. |
| Opération API |
Option permettant de sélectionner une opération dans la liste. Les opérations disponibles sont fournies par la spécification OpenAPI ou la collection Postman dans le champ Source de l’API . |
| Enregistrer en tant que pièce jointe | Option permettant de spécifier si la réponse doit être sauvegardée en tant qu’enregistrement dans la table des pièces jointes [sys_attachment]. |
| Chemin d'accès à la ressource | Chemin d’accès de la ressource. |
| Méthode HTTP | Méthode HTTP utilisée pour traiter la demande.
|
| Paramètres de requêtes |
Paires nom-valeur à transmettre au point de terminaison REST. Vous pouvez créer ces paramètres manuellement ou faire glisser les variables d’entrée dans les champs de paramètres, puis affecter une valeur. Prenez en charge les demandes d’étape REST qui contiennent des noms de paramètres de requête en double. Si vous créez une demande REST qui contient des noms de paramètres de requête en double, Studio de workflow les paramètres de requête sont ajoutés à la demande dans l’ordre dans lequel vous les avez définis. Remarque :
Lors de l’importation d’une spécification OpenAPI, le système ajoute tous les paramètres et en-têtes présents dans la spécification à l’étape REST. Examinez les valeurs finales de l’étape REST et supprimez les paramètres que vous ne souhaitez pas envoyer dans la demande. Par exemple, si l’API accepte les en-têtes de type contenu pour JSON et XML, le système ajoute les deux en-têtes à l’étape REST. Supprimez l’un des en-têtes en fonction du type de contenu que vous souhaitez recevoir dans la réponse. |
| En-têtes |
En-têtes à envoyer avec la demande. Vous pouvez créer des en-têtes manuellement ou faire glisser des variables d’entrée dans les champs de paramètres, puis affecter une valeur. Prise en charge des demandes de l’étape REST qui contiennent des en-têtes de demande en double. Si vous créez une demande REST qui contient des en-têtes de demande en double, les en-têtes sont envoyés dans le même ordre que celui dans lequel vous les avez définis. Remarque :
Lors de l’importation d’une spécification OpenAPI, le système ajoute tous les paramètres et en-têtes présents dans la spécification à l’étape REST. Examinez les valeurs finales de l’étape REST et supprimez les paramètres que vous ne souhaitez pas envoyer dans la demande. Par exemple, si l’API accepte les en-têtes de type contenu pour JSON et XML, le système ajoute les deux en-têtes à l’étape REST. Supprimez l’un des en-têtes en fonction du type de contenu que vous souhaitez recevoir dans la réponse. |
| Pièce jointe | Enregistrement de pièce jointe contenant la demande. Vous pouvez rechercher ou créer cet enregistrement à une étape antérieure et le définir comme variable d’entrée. Créez-le à l’aide des API JSONStreamingBuilder et XMLStreamingBuilder à l’étape Script. Remarque : Ce champ est disponible lorsque vous sélectionnez Binaire dans la liste Type de demande. |
| Activer la politique des nouveaux essais | Option permettant d’activer la politique des nouveaux essais. Pour plus d’informations, consultez la section Politique des nouveaux essais. |
| Remplacer la politique des nouveaux essais pour l’alias | Option permettant de remplacer la politique des nouveaux essais par défaut. Cette case à cocher ne s’applique pas lorsque l’option Définir l’inline de la connexion est sélectionnée dans la liste Connexion. |
| Politique des nouveaux essais | Politique de nouvelle tentative par défaut associée à l’alias de connexion. Si l’option Remplacer la politique des nouveaux essais pour l’alias est sélectionnée, vous pouvez remplacer la politique des nouveaux essais par défaut et sélectionner une autre politique existante en fonction de vos besoins. |
Évaluation des erreurs d’action
- En cas d'échec de cette étape
- Type de données : Choice
Option permettant de continuer à exécuter l’étape suivante ou d’accéder à l’évaluation des erreurs. Pour utiliser le code d’état d’étape ou le message pour une condition d’erreur d’action personnalisée, reportez-vous à la section Action error evaluation.
Évaluation des erreurs d’action
- En cas d'échec de cette étape
- Type de données : Choice
Option permettant de continuer à exécuter l’étape suivante ou d’accéder à l’évaluation des erreurs. Pour utiliser le code d’état d’étape ou le message pour une condition d’erreur d’action personnalisée, reportez-vous à la section Action error evaluation.
Limitations connues
Créez une étape OpenAPI à partir d’une spécification OpenAPI avec ces limitations.
- Types de médias de corps de demande
- Le corps de la demande prend uniquement en charge les types de médias JSON. Remarque :Un objet de sortie de type chaîne est créé lorsque le schéma OpenAPI a additionalProperties ou aucune propriété.
- Composants OpenAPI 3.0
OpenAPI 3.0 ajoute de nouveaux composants à Swagger 2.0 pour décrire une API plus en détail. La prise en charge d’OpenAPI dans l’étape OpenAPI prend en charge certains de ces composants, mais pas tous. L’étape OpenAPI ne prend actuellement pas en charge ces composants.
- Objet de schéma : propriétés additionalProperties
- Objet discriminateur
- Objet d’informations : termsOfService, champs de contact, licence
- Exemple d’objet
- Objet de lien
- Objet de rappel
- Objet du schéma de sécurité
- Objet des besoins de sécurité
- Objet de balise
- Objet de documentation externe
- Objet serveur
- Extensions de spécification
- Références récursives
De plus amples informations sur ces composants sont disponibles dans la documentation OpenAPI. Voir Spécification OpenAPI.
- Nombre maximal d’opérations prises en charge
- Le nombre d’opérations d’API est limité à 500 par défaut. Toutefois, en utilisant la propriété glide.rest.openapi.max_operation_limitsystème , vous pouvez configurer le nombre d’opérations de 1 à 1 000.