Étape OpenAPI
Importez la spécification OpenAPI d’un service Web REST sortant tiers et créez une intégration au service Web. Les détails de la demande pour l’opération REST API sous-jacente sont dérivés de la spécification OpenAPI.
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.
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 admin 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 de l’alias de connexion pour la demande REST. |
| Source de l'API | Option permettant de sélectionner une spécification OpenAPI v2.0 et v3.0 utilisée pour construire la demande, ou sélectionnez Importer OpenAPI pour importer une nouvelle spécification OpenAPI. Vous pouvez importer des spécifications en fournissant une URL et des informations d’identification au YAML ou au JSON, ou en copiant et collant du contenu. |
| 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 dans le champ Source de l’API . |
| 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, Concepteur de flux ajoute les paramètres de requête à la demande dans le même ordre que 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. Passez en revue les valeurs de l'étape REST finale 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 de contenu pour les formats 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 les variables d’entrée dans les champs de paramètres, puis affecter une valeur. Prendre en charge les demandes d’é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, ceux-ci 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. Passez en revue les valeurs de l'étape REST finale 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 de contenu pour les formats 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 la pièce jointe qui contient la demande. Vous pouvez rechercher ou créer cet enregistrement dans une étape préalable 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, reportez-vous à 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 n'est pas disponible si l'option Définir l'inline de la connexion est sélectionnée dans la liste des connexions. |
| Politique des nouveaux essais | Politique des nouveaux essais 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 des nouveaux essais en fonction de vos besoins. |
Champs d’évaluation des erreurs d’action
| Champ | Description |
|---|---|
| En cas d'échec de cette étape | Option permettant de continuer à exécuter l’étape suivante ou d’accéder à l’évaluation des erreurs. Pour utiliser le code d’état ou le message de l’étape pour une condition d’erreur d’action personnalisée, reportez-vous à Action error evaluation. |
Champs d’évaluation des erreurs d’action
| Champ | Description |
|---|---|
| En cas d'échec de cette étape | Option permettant de continuer à exécuter l’étape suivante ou d’accéder à l’évaluation des erreurs. Pour utiliser le code d’état ou le message de l’étape pour une condition d’erreur d’action personnalisée, reportez-vous à Action error evaluation. |
Limitations connues
Créez une étape OpenAPI à partir d’une spécification OpenAPI avec ces limitations.
- Types de médias du corps de la demande
- Le corps de la demande ne prend en charge que les types de médias JSON. Remarque :Un objet de sortie de type chaîne est créé lorsque le schéma OpenAPI a des propriétés supplémentaires 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 à 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 discriminant
- Objet d’informations : termsOfService, contact, champs de licence
- Exemple d’objet
- Objet de lien
- Objet de rappel
- Objet du schéma de sécurité
- Objet de besoins de sécurité
- Objet de balise
- Objet de documentation externe
- Objet serveur
- Extensions de spécifications
- Références récursives
Plus d’informations sur ces composants sont disponibles dans la documentation OpenAPI. Reportez-vous à la section 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, à l’aide de la propriété glide.rest.openapi.max_operation_limitsystème , vous pouvez configurer le nombre d’opérations de 1 à 1 000.