Импортировать API GraphQL

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

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

В этой статье вы узнаете:

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

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

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

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

Добавьте API GraphQL

На портале Azure откройте экземпляр API Management.
В левой области выберите API-интерфейсы>API-интерфейсы.
Выберите "Добавить API".
В разделе "Определение нового API" выберите плитку GraphQL .

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

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

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

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

# Details specific to API Management instance.
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 Management с именем apim-hello-world.

# Details specific to API Management instance.
$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. Выберите заголовок в меню "Имя ".
2. Введите значение в поле "Значение ".
3. Добавьте дополнительные заголовки, выбрав "Добавить заголовок".
4. Удалите заголовки с помощью кнопки корзины.
Если вы добавили продукт в API GraphQL, добавьте область видимости продукта под Применить область видимости продукта.
В редакторе запросов выполните одно из следующих действий.
1. Выберите по крайней мере одно поле или подполе в списке в меню слева от редактора. Выбранные поля и подполя отображаются в редакторе запросов.
2. Начните вводить текст в редакторе запросов, чтобы создать запрос.
В разделе Query variables (Переменные запроса) добавьте переменные для повторного использования одного запроса или изменения и передайте разные значения.
Выберите Отправить.
Просмотрите Ответ.
Повторите предыдущие шаги, чтобы проверить разные полезные нагрузки.
Завершив тестирование, закройте тестовую консоль.

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

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

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

Защита API GraphQL

Защита API GraphQL путем применения существующих политик проверки подлинности и авторизации GraphQL для защиты от атак, относящихся к GraphQL .

Обратная связь

Были ли сведения на этой странице полезными?

Last updated on 2025-10-07