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

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

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

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

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

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

Новый API в Управлении API

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

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

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

    Выбор "Службы управления API"

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

    Выбор экземпляра службы "Управление API"

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

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

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

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

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

  4. Введите значения из следующей таблицы. Затем щелкните Создать, чтобы создать API.

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

    Создание API

    Параметр Значение Описание
    Спецификация OpenAPI https://conferenceapi.azurewebsites.net?format=json Служба, которая реализует API. Управление API направляет запросы по этому адресу. Служба должна быть размещена по общедоступному адресу Интернета.
    Отображаемое имя Управление API заполняет это поле на основе кода JSON после ввода указанного выше URL-адреса службы. Это имя отображается на портале разработчика.
    имя; Управление API заполняет это поле на основе кода JSON после ввода указанного выше URL-адреса службы. Уникальное имя API.
    Описание Управление API заполняет это поле на основе кода JSON после ввода указанного выше URL-адреса службы. Необязательное описание 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 на портале Azure

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

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

  2. Выберите вкладку Тест, а затем — GetSpeakers. На странице будут показаны параметры запроса и заголовки, если они есть. Параметр Ocp-Apim-Subscription-Key заполняется автоматически ключом подписки, связанным с этим API.

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

    Тестирование API на портале Azure

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

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

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

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

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