Упражнение. Импорт и публикация API

  • 5 мин

Теперь, когда шлюз настроен, вы готовы импортировать и опубликовать API, чтобы партнеры могли получить доступ к инвентаризации и информации о продукте.

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

Примечание.

В этом упражнении используются ресурсы, настроенные в предыдущем упражнении.

Импорт API

Первая часть упражнения — импортировать API Обуви NorthWind в шлюз Управление API.

  1. В меню ресурсов на портале Azure или на домашней странице выберете пункт Все ресурсы, а затем — службу "Управление API".

  2. В меню службы Управление API в разделе API выберите API, а затем + Добавить API.

  3. В разделе Создание из определения выберите OpenAPI. Откроется панель Создание из спецификации OpenAPI.

    Добавление нового API.

  4. В окне спецификации OpenAPI выполните следующие параметры:

    Параметр Значение
    Спецификация OpenAPI Вставьте URL-адрес JSON Swagger, сохраненный из предыдущего упражнения.
    Показать имя Примите значение по умолчанию, которое должно быть равно NorthWindShoes Products.
    Имя. Примите значение по умолчанию, которое должно быть равно northwindshoes-products.
    Суффикс URL-адреса API Игнорируйте этот параметр.
    Базовый URL-адрес Примите значение по умолчанию.

    Примечание.

    Обратите внимание, что при вводе URL-адреса JSON некоторые другие поля будут заполнены автоматически. Это связано с тем, что мы использовали спецификацию OpenAPI, которая задает все необходимые сведения о подключении.

  5. Нажмите кнопку создания. На панели apim-NorthwindShoesNNNN | API отображаются все операции для API продуктов NorthWindShoes.

Визуализация API

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

  1. На apim-NorthwindShoesNNNN | Область API, выберите API продукта NorthWindShoes и перейдите на вкладку "Тест".

  2. Выберите первую операцию Get Поиск подробных сведений об указанном продукте. Сведения отображаются в тестовой консоли.

  3. В разделе "Параметры шаблона" введите числовое значение для параметра идентификатора продукта.

    Область

  4. Выполните прокрутку вниз и обратите внимание, что в поле URL-адрес запроса содержится суффикс /api/Products/{productid}.

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

    В ответ на запрос GET вы должны получить сообщение 200 ОК и сведения о введенном идентификаторе продукта.

    Далее протестируйте работу базового запроса GET без параметров.

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

    Панель

  7. Выполните прокрутку вниз и обратите внимание, что в поле URL-адрес запроса содержится суффикс /api/Inventory.

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

    В ответ на запрос GET вы должны получить сообщение 200 ОК, в полезных данных которого будут содержаться сведения об объеме запасов на складе.