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

2025-04-11

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

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

Примечание.

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

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

Импорт схемы GraphQL в экземпляр Управления API
Настройка сопоставителя для запроса GraphQL с помощью существующей конечной точки HTTP
Протестируйте API GraphQL

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

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

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

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

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

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

В меню навигации сбоку выберите API в разделе API.
В разделе Define a new API (Определение нового API) щелкните значок GraphQL.

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

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

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

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

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

Защита API GraphQL

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

Поделиться через