Импорт API GraphQL

Статья
05/21/2024

ОБЛАСТЬ ПРИМЕНЕНИЯ: все уровни Управление API

В Управление API можно добавить API GraphQL в одну из двух моделей: сквозную передачу в существующую конечную точку GraphQL или импортировать схему GraphQL и создать искусственный API GraphQL с настраиваемыми разрешениями полей. Дополнительные сведения см. в обзоре GraphQL.

Работая с этой статьей, вы узнаете о следующем.

Добавьте сквозной API GraphQL в экземпляр Управление API.
Протестируйте API GraphQL.

Если вы хотите импортировать схему GraphQL и настроить сопоставители полей с помощью конечных точек API REST или SOAP, см. статью Импорт схемы GraphQL и настройка сопоставителей полей.

Необходимые компоненты

Существующий экземпляр Управления API. Создайте его, если у вас его нет.
API GraphQL.
Azure CLI
- Используйте среду Bash в Azure Cloud Shell. Дополнительные сведения см . в кратком руководстве по Bash в Azure Cloud Shell.
- Если вы предпочитаете выполнять справочные команды CLI локально, установите Azure CLI. Если вы работаете в Windows или macOS, Azure CLI можно запустить в контейнере Docker. Дополнительные сведения см. в статье Как запустить Azure CLI в контейнере Docker.
  - Если вы используете локальную установку, выполните вход в Azure CLI с помощью команды az login. Чтобы выполнить аутентификацию, следуйте инструкциям в окне терминала. Сведения о других возможностях, доступных при входе, см. в статье Вход с помощью Azure CLI.
  - Установите расширение Azure CLI при первом использовании, когда появится соответствующий запрос. Дополнительные сведения о расширениях см. в статье Использование расширений с Azure CLI.
  - Выполните команду az version, чтобы узнать установленную версию и зависимые библиотеки. Чтобы обновиться до последней версии, выполните команду az upgrade.
Azure PowerShell
- Если вы решили использовать Azure PowerShell локально:
  - Установите последнюю версию модуля Az PowerShell.
  - Подключитесь к учетной записи Azure с помощью командлета Connect-AzAccount.
- Если вы решили использовать Azure Cloud Shell:
  - Дополнительные сведения см. в статье Общие сведения об Azure Cloud Shell.

Добавление API GraphQL

Перейдите к экземпляру Управления API на портале Azure.
В меню слева выберите API>+ Добавить API.
В разделе Define a new API (Определение нового API) щелкните значок GraphQL.

В открывшемся диалоговом окне выберите Полный и заполните обязательные поля формы.

Снимок экрана: поля для создания API GraphQL.

Поле	Описание:
Отображаемое имя	Это имя, под которым будет отображаться этот API GraphQL.
Имя	Необработанное имя API Graph. Оно заполняется автоматически при вводе отображаемого имени.
Тип GraphQL	Выберите Pass-through GraphQL для импорта из существующей конечной точки API GraphQL .
Конечная точка API GraphQL	Базовый URL-адрес с именем конечной точки API GraphQL. Например: `https://example.com/your-GraphQL-name`. Вы также можете использовать общую конечную точку GraphQL "swapi", например `https://swapi-graphql.azure-api.net/graphql` демонстрацию.
Отправить схему	При необходимости выберите для просмотра и отправки файл схемы, чтобы заменить схему, полученную из конечной точки GraphQL (если она доступна).
Description	Добавьте описание API.
Схема URL-адресов	Сделайте выбор на основе конечной точки GraphQL. Выберите один из вариантов, включающих схему WebSocket (WS или WSS), если API GraphQL включает тип подписки. Выбор по умолчанию: HTTP(S).
Суффикс URL-адреса API	Добавьте суффикс URL-адреса для идентификации этого API в данном экземпляре Управления API. Он должен быть уникальным в этом экземпляре Управления API.
Базовый URL-адрес	Недоступное для редактирования поле, отображающее базовый URL-адрес API
Теги	Сопоставьте API GraphQL с новыми или существующими тегами.
Товары	Сопоставьте API GraphQL с определенным продуктом, чтобы опубликовать его.
Версия этого API	Выберите, чтобы применить схему управления версиями к API GraphQL.

Нажмите кнопку создания.
После создания API просмотрите или измените схему на вкладке "Конструктор ".

В следующем примере используется команда импорта apim api az для импорта сквозного API GraphQL из указанного URL-адреса в экземпляр Управление API с именем apim-hello-world.

# API Management service-specific details
APIMServiceName="apim-hello-world"
ResourceGroupName="myResourceGroup"

# API-specific details
APIId="my-graphql-api"
APIPath="myapi"
DisplayName="MyGraphQLAPI"
SpecificationFormat="GraphQL"
SpecificationURL="<GraphQL backend endpoint>"

# Import API
az apim api import --path $APIPath --resource-group $ResourceGroupName \
    --service-name $APIMServiceName --api-id $APIId \
    --display-name $DisplayName --specification-format $SpecificationFormat --specification-url $SpecificationURL

После импорта API при необходимости можно обновить параметры с помощью команды az apim api update .

В следующем примере используется командлет Import-AzApiManagementApi Azure PowerShell для импорта сквозного API GraphQL из указанного URL-адреса в экземпляр Управление API с именем apim-hello-world.

# API Management service-specific details
$apimServiceName = "apim-hello-world"
$resourceGroupName = "myResourceGroup"

# API-specific details
$apiId = "my-graphql-api"
$apiPath = "myapi"
$specificationFormat = "GraphQL"
$specificationUrl = "<GraphQL backend endpoint>"

# Get context of the API Management instance. 
$context = New-AzApiManagementContext -ResourceGroupName $resourceGroupName -ServiceName $apimServiceName

# Import API
Import-AzApiManagementApi -Context $context -ApiId $apiId -SpecificationFormat $specificationFormat -SpecificationUrl $specificationUrl -Path $apiPath

После импорта API при необходимости можно обновить параметры с помощью командлета Set-AzApiManagementApi .

Протестируйте API GraphQL

Перейдите к экземпляру Управления API.
В меню навигации сбоку выберите API в разделе API.
В разделе All APIs (Все API) выберите API GraphQL.
Откройте вкладку Тестирование, чтобы перейти к консоли тестирования.
Под разделом Headers (Заголовки):
1. Выберите заголовок в раскрывающемся меню Name (Имя).
2. Введите значение в поле Value (Значение).
3. Добавьте дополнительные заголовки, нажав кнопку + Add header (Добавить заголовок).
4. Удалите заголовки с помощью значка корзины.
Если вы добавили продукт в API GraphQL, примените область продукта в разделе Apply product scope (Применить область продукта).
В редакторе запросов выполните одно из следующих действий:
1. Выберите хотя бы одно поле или подполе в списке в боковом меню. Выбранные поля и подполя отображаются в редакторе запросов.
2. Начните вводить текст в редакторе запросов, чтобы создать запрос.
В разделе Query variables (Переменные запроса) добавьте переменные для повторного использования одного запроса или изменения и передайте разные значения.
Выберите Отправить.
Просмотрите Response (Ответ).
Повторите предыдущие шаги, чтобы проверить различные полезные данные.
По завершении тестирования закройте консоль тестирования.

Тестирование подписки

Если API GraphQL поддерживает подписку, ее можно протестировать в тестовой консоли.

Убедитесь, что API разрешает схему URL-адресов WebSocket (WS или WSS), подходящую для ВАШЕГО API. Этот параметр можно включить на вкладке "Параметры ".
Настройте запрос подписки в редакторе запросов, а затем выберите Подключиться, чтобы установить подключение WebSocket к серверной службе.
Просмотрите сведения о подключении на панели Подписка.
События подписки отображаются на панели "Подписка ". Подключение WebSocket сохраняется до тех пор, пока вы не отключите его или не подключитесь к новой подписке WebSocket.