Реализация тестирования подключения

  • Статья

Тестовое подключение — это простая точка входа, которую можно определить для соединителя и использовать с Azure Logic Apps, Power Automate или Power Apps. Выполняя операцию для тестового подключения, соединитель может обеспечивать проверку параметров подключения во время разработки и выполнения.

Предварительные условия

Добавление новой операции тестирования подключения

Добавление операции TestConnection — очень простой процесс. Вы можете использовать существующую операцию в качестве средства тестирования подключения или добавить конкретную операцию, предназначенную проверять только параметры подключения. В операции должна быть команда get, и она должна поддерживать вызов без параметров или с жестко заданными параметрами.

Добавить новую операцию в спецификации OpenAPI с этой целью можно следующим образом.

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

Важно!

Обратите внимание, что эта операция помечена как internal. При добавлении новой точки входа для соответствующей цели настоятельно рекомендуется скрыть эту операцию от пользователей, поставив такую отметку видимости.

Конечную точку, предназначенную для использования в качестве тестового подключения, нужно идентифицировать. Для этого добавьте расширение в API на верхнем уровне, например так:

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

Чтобы быть допустимым, идентификатор operationId, указанный в этом атрибуте, должен существовать в этой же спецификации OpenAPI.

Повторное использование существующей операции тестирования подключения

Часто бывает проще и удобнее указать существующую операцию, которая может проверять работу подключения, чтобы избежать больших затрат и задержек. Для этого не нужно добавлять новую операцию. Необходимо просто указать, какую операцию использовать и какие параметры передавать (если такие есть).

В приведенном ниже примере мы используем существующую операцию «get» с именем GetTables. Она будет выполнена успешно, если подключение допустимо, а параметры правильно заданы. Чтобы максимально повысить скорость выполнения операции тестирования подключения, в примере в вызов также добавляется параметр, указывающий, что должна возвращаться только первая строка.

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

Реализация тестирования подключения

Если необходимо реализовать тестирование подключения и подходящей существующей операции нет, это можно сделать с использованием простого вызова, отправленного к серверной части. Такая операция может не принимать никаких параметров и не возвращать какого-либо содержимого. Путь по URL-адресу также неважен. Его можно выбрать в зависимости от предпочтений. Единственный критерий правильности вызова тестового подключения — это успешный ответ на HTTP-вызов (например, 200). В рамках операции тестирования подключения контракт запрашивает у соединителя проверку контекста аутентификации и параметров подключения.

Для этого можно отправить к серверу запрос, который будет использовать параметры проверки подлинности, а также любую базу данных или необходимую область. Хороший пример проверки подключения — запрос к верхней строке простой таблицы.

Предоставление отзывов

Для нас очень важны отзывы о проблемах с нашей платформой соединителей и новые идеи о функциях. Чтобы оставить отзыв, выберите пункт Сообщить о проблемах или получить помощь с соединителями и выберите тип отзыва.