Руководство по Импорт и публикация первого API

В этом руководстве показано, как импортировать api серверной части спецификации OpenAPI в формате JSON в Azure Управление API. Корпорация Майкрософт предоставляет используемый в этом примере API серверной части в Azure по адресу https://conferenceapi.azurewebsites.net.

Когда API серверной части будет импортирован в службу "Управление API", ваш программный интерфейс Управления API будет использоваться как фасад для API серверной части. Вы можете настраивать фасад в Управлении API согласно своим потребностям, не используя API серверной части. Дополнительные сведения см. в статье Transform and protect your API (Преобразование и защита API).

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

  • импорт API в Управление API;
  • проверка API на портале Azure;

После импорта API-интерфейсом можно управлять на портале Azure.

Снимок экрана: новый API в Управление API на портале.

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

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

  1. На портале Azure найдите и выберите службы Управление API.

    Выбор

  2. На странице Службы Управления API выберите экземпляр Управления API.

    Выбор экземпляра службы

Импорт и публикация API серверной части

В этом разделе показано, как импортировать и опубликовать API серверной части "Спецификация OpenAPI".

  1. В области навигации экземпляра Управления API слева выберите API.

  2. Выберите плитку OpenAPI.

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

  4. Введите значения из следующей таблицы.

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

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

    Параметр Значение Описание
    Спецификация OpenAPI https://conferenceapi.azurewebsites.net?format=json Указывает серверную службу, реализующую API, и операции, поддерживаемые API.

    URL-адрес серверной службы появится позже в качестве URL-адреса веб-службы на странице Параметры API.

    После импорта можно добавлять, изменять, переименовывать или удалять операции в спецификации.
    Включение параметров запроса в шаблоны операций Установлен (по умолчанию) Указывает, следует ли импортировать необходимые параметры запроса в спецификации в качестве параметров шаблона в Управление API.
    Отображаемое имя После ввода URL-адреса спецификации OpenAPI Управление API заполняет это поле на основе JSON. Это имя отображается на портале разработчика.
    имя; После ввода URL-адреса спецификации OpenAPI Управление API заполняет это поле на основе JSON. Уникальное имя API.
    Описание После ввода URL-адреса спецификации OpenAPI Управление API заполняет это поле на основе JSON. Необязательное описание API.
    Схема URL-адресов HTTPS Определяет, какие протоколы можно использовать для доступа к этому API.
    Суффикс URL-адреса API conference Этот суффикс добавляется к основному URL-адресу службы "Управление API". Управление API различает API по их суффиксу. Поэтому у каждого API для заданного издателя суффикс должен быть уникальным.
    Теги Теги для упорядочивания API для поиска, группирования или фильтрации.
    Продукты Unlimited Ассоциация из одного или нескольких API. Каждый экземпляр "Управление API" поставляется с двумя демонстрационными продуктами: Starter и Unlimited. Чтобы опубликовать API, его нужно связать с определенным продуктом, в этом примере — с продуктом Unlimited.

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

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

    Управляемый обозначает шлюз, встроенный в службу управления API и размещенный корпорацией Майкрософт в Azure. Локальные шлюзы доступны только в службах уровня "Разработка" и "Премиум". Вы можете развернуть их локально или в других облаках.

    Если шлюзы не выбраны, API не будет доступен и запросы к API не будут выполнены.
    Версия этого API Установите или снимите флажок Дополнительные сведения см. в статье Публикация нескольких версий API предсказуемым способом.

    Примечание

    Чтобы опубликовать API для потребителей, его нужно связать с определенным продуктом.

  5. Щелкните Создать, чтобы создать API.

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

Проверка нового API на портале Azure

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

  1. В области навигации экземпляра Управления API слева выберите API>Demo Conference API.

  2. Выберите вкладку Тест, а затем — GetSpeakers. На странице будут показаны параметры запроса и заголовки, если они есть.

    В разделе HTTP-запроса заголовок Ocp-Apim-Subscription-Key заполняется автоматически, что можно увидеть, щелкнув значок глаза.

  3. Нажмите кнопку Отправить.

    Снимок экрана: тестирование API в портал Azure.

    Служба серверной части вернет ответ 200 — ОК и другие данные.

Дальнейшие действия

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

  • импорт API;
  • проверка API на портале Azure;

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