Руководство. Ответы API макета

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

Серверные API импортируются в API Управления API (APIM) или создаются и управляются вручную. Действия, описанные в этом учебнике, показывают, как:

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

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

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

• Когда сначала создается интерфейсная часть API, а затем — серверная реализация. Или когда серверная часть разрабатывается параллельно.
• Когда серверная часть временно не работает или ее невозможно масштабировать.

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

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

Необходимые компоненты

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

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

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

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

2. Выберите API>+ Добавить API>HTTP.

   

3. В окне Создать API HTTP выберите Полный.

4. Введите Тестовый API в качестве отображаемого имени.

5. Выберите Без ограничений в поле Продукты.

6. Убедитесь, что для параметра Шлюзы выбрано значение Управляемые.

7. Нажмите кнопку создания.

   

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

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

Портал

1. Выберите API, созданный на предыдущем шаге.

2. Щелкните + Add Operation (+ Добавить операцию).

3. В окне Интерфейс введите следующие значения.

   

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

4. Выберите вкладку Ответы, которая находится под полями "URL-адрес", "Отображаемое имя" и "Описание". Введите параметры на этой вкладке, чтобы определить коды состояния ответа, типы содержимого, примеры и схемы.

5. Выберите + Добавить ответ и в списке выберите 200 ОК.

   

6. Справа от раздела Представления выберите + Add representation (+ Добавить представление).

7. В поле поиска введите application/json и выберите тип содержимого application/json.

8. В текстовом поле Образец введите { "sampleField" : "test" }.

9. Выберите Сохранить.

   

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

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

Azure CLI

Чтобы начать работу с 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.

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

az apim api operation create --resource-group apim-hello-word-resource-group \
    --display-name "Test call" --api-id test-api --method GET \
    --url-template /test --service-name apim-hello-world 

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

az apim api operation list --resource-group apim-hello-word-resource-group \
    --api-id test-api --service-name apim-hello-world --output table

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

az apim api operation delete --resource-group apim-hello-word-resource-group \
    --api-id test-api --operation-id 00000000000000000000000000000000 \
    --service-name apim-hello-world

Сохраните эту операцию для последующего использования при работе с этой статьей.

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

1. Выберите API, созданный на этапе Создание тестового API.

2. В окне справа убедитесь, что выбрана вкладка Конструктор.

3. Выберите добавленную тестовую операцию.

4. Нажмите + Добавить политику в окне Обработка входящих запросов.

   

5. Выберите Макетировать ответы из коллекции.

   

6. В текстовом поле API Management response (Ответ службы управления API) введите 200 OK, application/json. Этот параметр указывает, что API должен возвращать пример ответа, определенный в предыдущем разделе.

   

7. Выберите Сохранить.

   Совет

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

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

1. Выберите API, созданный на этапе Создание тестового API.

2. Откройте вкладку Тест.

3. Убедитесь, что выбран API Тестовый вызов, а затем нажмите кнопку Отправить, чтобы выполнить тестовый вызов.

   

4. В качестве образца в первом разделе руководства отображается HTTP-ответ JSON.

   

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

Из этого руководства вы узнали, как:

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

Перейдите к следующему руководству:

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