Ce connecteur est disponible dans les modes suivants :
| Mode Desktop ✅ | Mode SaaS Online ❌ |
Cet article explique comment utiliser le connecteur OpenAPI pour DataGalaxy.
Présentation du connecteur
Swagger est un outil permettant de générer de la documentation pour les API REST basé sur la spécification OpenAPI. Le connecteur OpenAPI permet donc de lire des fichiers de spécifications (fichiers .yml, .yaml, .json) et d'importer les définitions d'objets correspondantes dans une source de type NoSQL . Les objets récupérés et leurs correspondances dans DataGalaxy sont détaillés dans le tableau suivant :
| Objet OpenAPI | Objet DataGalaxy | Commentaires |
| Path (URL de l'API) | Répertoires | Suivant le mode de représentation choisi, l'URL de l'API et le chemin d'appel des méthodes seront décomposés ou regroupés pour reproduire la structure de l'API |
| (Opération GET/POST/PUT/DELETE/...) | Répertoire | Chaque opération décrite donne lieu à la création d'un répertoire |
| "parameters" | Fichier | |
| Parameters | Champs / Sous structures | L'arborescence complète de la structure d'objet est représentée dans DataGalaxy, en exploitant la notion de sous structure lorsque c'est nécessaire. Le type d'un schéma dans les fichiers sources est donc obligatoire pour déduire le type cible. |
| "responses" | Fichier | |
| (Code de réponse) | Sous structure | Chaque code de réponse (200, 401, 415, ...) donne lieu à la création d'une sous structure |
| (Objets de la réponse) | Champs / Sous structures | L'arborescence complète de la structure d'objet de la réponse est représentée dans DataGalaxy, en exploitant la notion de sous structure lorsque c'est nécessaire. Le type d'un schéma dans les fichiers sources est donc obligatoire pour déduire le type cible. |
Etape 1 : Installation
- Télécharger le connecteur DataGalaxy depuis le portail (voir ici)
- Extraire l'archive du connecteur dans le répertoire de votre choix
- Télécharger le plug-in OpenAPI (Swagger) depuis le portail et le copier dans le répertoire /lib du connecteur
Etape 2 : Exécution du connecteur OpenAPI
- Après avoir démarré le connecteur, accéder aux connecteurs du Dictionnaire :
- S'il a été correctement installé, le plug-in OpenAPI apparaît dans la liste
- Les informations suivantes sont demandées :
| Paramètre | Obligatoire | Description |
| Chemin | Oui | Chemin d'un répertoire contenant des fichiers de spécification Open API (.yml, .yaml, .json) |
| Ignorer les erreurs | Non | Option permettant d'ignorer la présence de fichiers mal structurés ou ne pouvant pas être interprétés, afin de continuer le traitement lorsqu'une erreur est détectée. Lorsqu'elle est décochée, la présence d'un fichier en erreur bloque le processus d'import (fonctionnement par défaut). |
| Remplacer les variables dans l'URL | Non | Option permettant de remplacer les variables dans l'URL avec leurs valeurs par défaut déclarées dans les fichiers. |
| Décrire uniquement le format des réponses en succès | Non | Option permettant d'ignorer les réponses ayant un code HTTP différent de 200. |
| Inclure tout les formats (media-types) des requêtes | Non | Option permettant de prendre en compte les media-types présents dans les requêtes en tant que sous-structure |
| Inclure tout les formats (media-types) des réponses | Non | Option permettant de prendre en compte les media-types présents dans les réponses en tant que sous-structure |
| Mode de représentation des conteneurs DataGalaxy | Oui | Permet de définir la règle de représentation dans DataGalaxy de l'URL et des chemins d'opérations (endpoint) de l'API.
|
Une fois ces informations renseignées, vous pouvez lancer la procédure d'import.
Plus d'informations sur le mode opératoire du connecteur disponibles ici
Informations techniques
Le connecteur supporte les versions 2 et 3 de la spécification OpenAPI.
Lien vers la documentation Swagger et les spécifications OpenAPI : https://swagger.io/specification/
Releases
Date | Plugin | DataGalaxy | Desktop Connector | Description |
16/07/2024 | 7.0.0 | v3.59.0 | 5.0.1 | Migrated from java 11 to java 17 |