Добавление искусственного API GraphQL и настройка сопоставителей полей

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

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

Примечание.

В настоящее время эта функция недоступна в рабочих областях.

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

Импортируйте схему GraphQL в экземпляр службы "Управление API Azure".
Настройте резольвер для запроса GraphQL с помощью существующего HTTP-эндпоинта.
Протестируйте API GraphQL.

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

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

Существующий экземпляр API-менеджмента. Создайте его, если у вас его нет.
Допустимый файл схемы GraphQL с расширением .graphql.
В этом сценарии конечная точка в серверной части GraphQL является необязательной.

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

На портале Azure найдите и выберите службы управления API:
На странице управления API выберите ваш экземпляр службы управления API:

Добавление схемы GraphQL

В левой области в разделе API выберите API.
В разделе "Определение нового API" выберите плитку GraphQL .

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

Ценность	Описание:
Отображаемое имя	Имя, под которым будет отображаться ваш API GraphQL.
Имя	Необработанное имя API GraphQL. Оно заполняется автоматически при вводе отображаемого имени.
Тип GraphQL	Выберите Синтетический GraphQL, чтобы импортировать из файла схемы GraphQL.
Резервная конечная точка GraphQL	При необходимости введите URL-адрес с именем конечной точки API GraphQL. Управление API передает запросы GraphQL в эту конечную точку, если настраиваемый резолвер для конкретного поля не задан.
Описание	Добавьте описание API.
Схема URL-адресов	Выберите шаблон на основе конечной точки API 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 просмотрите или измените схему на вкладке "Схема ".

Настройка резолвера

Настройте сопоставитель для сопоставления поля в схеме с существующей конечной точкой HTTP. Здесь приведены высокоуровневые шаги. Дополнительные сведения см. в разделе "Настройка сопоставителя GraphQL".

Предположим, вы импортировали следующую базовую схему GraphQL и хотите настроить сопоставитель для users запроса.

type Query {
    users: [User]
}

type User {
    id: String!
    name: String!
}

В левой области в разделе API выберите API.
Выберите API GraphQL.
На вкладке "Схема" просмотрите схему поля в типе объекта, в котором требуется настроить сопоставитель.
1. Выберите поле, а затем наведите указатель на левую границу.
2. Выберите Добавить резолвер.
В панели создать сопоставитель :
1. Обновите свойство Name, если вы хотите, при необходимости введите описание и подтвердите или обновите выбор типа и поля.
2. В источнике данных выберите HTTP API.
В редакторе политики разрешателя обновите элемент <http-data-source> с дочерними элементами для вашего сценария. Например, следующий резолвер извлекает поле users, делая вызов к существующему источнику данных HTTP GET.
```
    <http-data-source>
        <http-request>
            <set-method>GET</set-method>
            <set-url>https://myapi.contoso.com/users</set-url>
        </http-request>
    </http-data-source>
```
Нажмите кнопку создания.
Чтобы обработать данные для другого поля в схеме, повторите описанные выше действия, чтобы создать другой резолвер.

Совет

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

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

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

Защита API GraphQL

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

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

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

Last updated on 2025-10-08