Учебное пособие: Моделирование ответов API

Статья
2025-04-16

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

Внутренние API импортируются в API управления API Azure или создаются и управляются вручную. В этом руководстве описано, как:

Используйте управление API для создания пустого HTTP-API.
Управление API HTTP вручную.
Задайте политику в API, чтобы она возвращала макет ответа.

Этот метод позволяет разработчикам продолжать реализацию и тестирование экземпляра управления API, даже если серверная часть недоступна для отправки реальных ответов.

Совет

Команды API могут использовать эту функцию в рабочих областях. Рабочие области предоставляют изолированный административный доступ к API и собственным средам выполнения API.

Возможность создания макетных ответов полезна во многих сценариях:

При разработке сначала фасада API, а реализация серверной части происходит позже, или при параллельной разработке серверной части.
Если серверная часть временно не работает или не может масштабироваться.

В этом руководстве описано следующее:

создание тестового API;
добавление операции в тестовый API;
Включение имитации ответа
Протестируйте моделированный API.

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

Изучите терминологию управления API.
Понять концепцию политик в управлении API.
Выполните краткое руководство по созданию экземпляра службы Управление API Azure.

создание тестового API;

В этом разделе показано, как создать API HTTP без серверной части.

Войдите на портал Azure и перейдите к своему экземпляру Управления API.
Выберите кнопку API>+ Добавить API>HTTP :
В окне Создать API HTTP выберите Полный.
В поле Отображаемое имя введите API тестирования.
В разделе "Продукты" выберите "Неограниченное", если это значение доступно. Это значение доступно только на некоторых уровнях. Вы можете оставить значение пустым для этого руководства, но необходимо связать API с продуктом, чтобы опубликовать его. Дополнительные сведения см. в статье "Импорт и публикация первого API".
В шлюзах выберите "Управляемый" , если этот параметр доступен. (Этот параметр доступен только на определенных уровнях служб.)
Нажмите кнопку создания.

добавление операции в тестовый API;

API предоставляет одну или несколько операций. В этом разделе описано, как добавить операцию в созданный API HTTP. Вызов операции после завершения действий в этом разделе вызывает ошибку. После выполнения действий в разделе «Включение имитации ответов», вы не получите ошибку.

Портал
Azure CLI

Выберите API, созданный на предыдущем шаге.
Щелкните + Add Operation (+ Добавить операцию).

В окне внешнего интерфейса введите следующие значения:

Настройка	значение	Описание
Отображаемое имя	Test call (Пробный вызов)	Имя, отображаемое на портале разработчика.
URL-адрес (первое поле)	ПОЛУЧИТЬ	Выберите одну из предварительно заданных HTTP-команд.
URL-адрес (второе поле)	test/	URL-путь для API.
Description		Необязательное описание операции. Она предоставляет документацию на портале разработчиков разработчикам, использующим API.

Выберите вкладку "Ответы" , которая находится в полях URL-адреса, отображаемое имя и описание . На этой вкладке вы введете значения, чтобы определить коды состояния ответа, типы контента, примеры и схемы.
Выберите и добавьте ответ, а затем нажмите кнопку 200 ОК из списка.
В разделе "Представления" выберите +Добавить представление.
Введите application/json в поле поиска и выберите тип контента application/json .
В поле "Пример" введите { "sampleField" : "test" }.
Выберите Сохранить.

Хотя это не обязательно для этого примера, можно настроить дополнительные параметры для операции API на других вкладках, как описано в следующей таблице:

Вкладка	Описание
Запрос	Добавьте параметры запроса. Помимо имени и описания можно также указать значения, привязанные к данному параметру запроса. Одно из значений можно пометить как значения по умолчанию (необязательно).
Запросить	Задайте типы содержимого, примеры и схемы запросов.

Чтобы начать работу с Azure CLI:

Используйте среду 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.

Чтобы добавить операцию в API тестирования, выполните команду az apim api operation create:

az apim api operation create --resource-group <resource-group> \
    --display-name "Test call" --api-id test-api --method GET \
    --url-template /test --service-name <API-management-service-name>

Чтобы просмотреть все операции для API, выполните команду az apim api operation list:

az apim api operation list --resource-group <resource-group-name> \
    --api-id test-api --service-name <API-management-service-name> --output table

Сохраните эту операцию для использования в остальной части этой статьи. Если вы хотите удалить операцию, можно использовать команду az apim api operation delete . Получите идентификатор операции из предыдущей команды.

az apim api operation delete --resource-group <resource-group-name> \
    --api-id test-api --operation-id <ID> \
    --service-name <API-management-service-name>

Включение имитации ответа

Выберите API, созданный на этапе Создание тестового API.
Убедитесь, что выбрана вкладка "Конструктор ".
Выберите добавленную тестовую операцию.
В разделе Обработка входящих данных выберите + Добавить политику.
Выберите элемент "Моделированные ответы" из галереи.
Убедитесь , что 200 ОК, приложение или json отображается в окне ответа управления API . Этот выбор указывает, что API должен возвращать пример ответа, определенный в предыдущем разделе.
Выберите Сохранить.

Совет

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

тестирование имитированного API.

Выберите API, созданный на этапе Создание тестового API.
На вкладке "Тест" убедитесь, что выбран API тестового вызова , а затем нажмите кнопку "Отправить ", чтобы выполнить тестовый вызов:
Ответ HTTP отображает JSON, предоставленный в качестве примера в первом разделе руководства:

Следующий шаг

Go to the next tutorial:

Преобразование и защита опубликованного API