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

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

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

1. Перейдите к экземпляру Управления API.

2. В меню навигации сбоку выберите API в разделе API.

3. В разделе All APIs (Все API) выберите API GraphQL.

4. Откройте вкладку Тестирование, чтобы перейти к консоли тестирования.

5. В разделе Headers:

   1. Выберите заголовок в раскрывающемся меню Name (Имя).
   2. Введите значение в поле Value (Значение).
   3. Добавьте дополнительные заголовки, нажав кнопку + Add header (Добавить заголовок).
   4. Удалите заголовки с помощью значка корзины.

6. Если вы добавили продукт в API GraphQL, примените область продукта в разделе Apply product scope (Применить область продукта).

7. В редакторе запросов выполните одно из следующих действий:

   1. Выберите хотя бы одно поле или подполе в списке в боковом меню. Выбранные поля и подполя отображаются в редакторе запросов.

   2. Начните вводить текст в редакторе запросов, чтобы создать запрос.

      

8. В разделе Query variables (Переменные запроса) добавьте переменные для повторного использования одного запроса или изменения и передайте разные значения.

9. Выберите Отправить.

10. Просмотрите Ответ.

    

11. Повторите предыдущие шаги, чтобы проверить различные передаваемые данные.

12. По завершении тестирования закройте консоль тестирования.

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

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

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

2. Настройте запрос подписки в редакторе запросов, а затем выберите Подключиться, чтобы установить подключение WebSocket к серверной службе.

   

3. Просмотрите сведения о подключении на панели Подписка.

   

4. События подписки отображаются на панели "Подписка ". Подключение WebSocket сохраняется до тех пор, пока вы не отключите его или не подключитесь к новой подписке WebSocket.

   

Защита API GraphQL

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

Связанный контент

• Ограничения импорта API
• Импорт спецификации OpenAPI
• Импортируйте SOAP API
• импортируйте API SOAP и преобразуйте его в REST
• Импорт API Службы приложений
• Импорт API контейнерного приложения
• Импорт API WebSocket
• Импортируйте API GraphQL
• Импорт схемы GraphQL и настройка сопоставителей полей
• Импортировать API приложения Azure Function
• Импорт API логического приложения Azure
• Импорт сервиса Service Fabric
• Импорт API Azure OpenAI
• Импортировать OData API
• Импорт метаданных SAP OData
• Импортирование gRPC API
• Изменение API