Implémenter Tester la connexion

Tester la connexion est un point d’entrée simple qui peut être défini pour un connecteur en vue d’une utilisation avec Azure Logic Apps, Power Automate ou Power Apps. En exposant une opération pour tester la connexion, le connecteur peut fournir la validation des paramètres de connexion au moment de la conception et de l’exécution.

Conditions préalables

• Expérience de base de création d’applications logiques ou de flux, et de connecteurs personnalisés.
• Notions de base sur la spécification OpenAPI (anciennement appelée Swagger).
• Un compte GitHub.
• L’exemple de définition OpenAPI pour ce tutoriel.

Ajouter une nouvelle opération Tester la connexion

L’ajout d’une opération pour TestConnection est un processus très simple. Vous avez la possibilité d’utiliser une opération existante comme moyen de test de la connexion ou d’ajouter une opération spécifique dont le travail consiste uniquement à tester les paramètres de connexion. L’opération doit être de type « get » et prendre en charge un appel sans paramètre ou avec des paramètres codés en dur.

L’ajout d’une nouvelle opération à cet effet peut se présenter comme suit dans la spécification OpenAPI :

    "/diagnostics/testconnection": {
      "get": {
        "tags": [ "Diagnostics" ],
        "operationId": "TestMyAPIConnection",
        "consumes": [],
        "produces": [],
        "responses": {
          "200": { "description": "OK" },
          "default": { "description": "Operation Failed." }
        },
        "x-ms-visibility": "internal"
      }
    }

Important

Notez que cette opération est marquée comme internal. Si vous ajoutez un nouveau point d’entrée à cet effet, il est vivement recommandé de masquer cette opération à l’utilisateur en marquant la visibilité comme telle.

Le point de terminaison destiné à être utilisé comme test de la connexion doit être identifié par l’ajout d’une extension à l’API au niveau supérieur :

 "x-ms-capabilities": {
    "testConnection": {
      "operationId": "TestMyAPIConnection",
      "parameters": {}
    }
  }

Le operationId spécifié dans cet attribut doit exister dans cette même spécification OpenAPI pour être valide.

Réutiliser une opération existante pour tester la connexion

Il est souvent plus simple et plus gérable d’identifier une opération existante qui peut valider la viabilité de la connexion, sans occasionner de coûts ou de latence. Cela peut être accompli sans ajouter une nouvelle opération, mais en indiquant simplement l’opération à utiliser, ainsi que les paramètres à passer (le cas échéant).

L’exemple suivant utilise une opération « get » existante appelée GetTables, qui doit réussir si la connexion est valide et que les paramètres sont corrects. Pour que l’opération de test de la connexion s’exécute aussi rapidement que possible, l’exemple ajoute également un paramètre à l’appel, indiquant que seule la première ligne doit être retournée.

 "x-ms-capabilities": {
    "testConnection": {
      "operationId": "GetTables",
      "parameters": {
        "$top": 1
      }
    }
  }

Implémenter Tester la connexion

Si vous avez besoin d’implémenter l’opération Tester la connexion et qu’aucune autre opération existante ne convient à cet effet, vous pouvez le faire avec un appel back-end simple. L’opération n’a besoin d’aucun paramètre et ne retourne aucun contenu. Le chemin de l’URL est également sans importance ; vous pouvez le sélectionner en fonction de vos préférences. La seule mesure de réussite d’un appel Tester la connexion est une réponse réussie (par exemple, 200) provenant de l’appel HTTP. Dans le cadre de l’opération Tester la connexion, le contrat requiert que le connecteur valide le contexte d’authentification et les paramètres de connexion.

Cela peut être accompli en interrogeant un événement simple sur le back-end, utilisant les paramètres d’authentification et toute base de données ou étendue qui peut être implicite. L’interrogation de la ligne supérieure d’une table simple est un bon exemple d’approche de test de la connexion.

Fournir des commentaires

Nous apprécions grandement les commentaires sur les problèmes liés à notre plateforme de connecteurs ou les idées de nouvelles fonctionnalités. Pour fournir des commentaires, accédez à Soumettre des problèmes ou obtenir de l’aide avec les connecteurs et sélectionnez votre type de commentaire.