Учебник. Импорт и публикация первого API
ОБЛАСТЬ ПРИМЕНЕНИЯ: все уровни Управление API
В этом руководстве показано, как импортировать внутренний API спецификации OpenAPI в формате JSON в Управление API Azure. В этом примере импортируется API открытый код Petstore.
Когда API серверной части будет импортирован в службу "Управление API", ваш программный интерфейс Управления API будет использоваться как фасад для API серверной части. Вы можете настраивать фасад в Управлении API согласно своим потребностям, не используя API серверной части. Дополнительные сведения см. в статье Transform and protect your API (Преобразование и защита API).
В этом руководстве описано следующее:
- импорт API в Управление API;
- проверка API на портале Azure;
После импорта API-интерфейсом можно управлять на портале Azure.
Необходимые компоненты
- Ознакомьтесь с терминологией службы "Управление API" в Azure.
- Создание экземпляра службы управления API Azure.
Перейдите к экземпляру службы управления API.
На портале Azure найдите и выберите службы Управление API.
На странице Службы Управления API выберите экземпляр Управления API.
Импорт и публикация API серверной части
В этом разделе показано, как импортировать и опубликовать API серверной части "Спецификация OpenAPI".
В области навигации экземпляра Управления API слева выберите API.
Выберите плитку OpenAPI.
В окне Создание из спецификации OpenAPI выберите Полный.
Введите значения из следующей таблицы.
Можно задать значения API во время создания или позже, перейдя на вкладку Параметры.
Параметр значение Описание Спецификация OpenAPI https://petstore3.swagger.io/api/v3/openapi.json Указывает серверную службу, реализующую API, и операции, поддерживаемые API.
URL-адрес серверной службы появится позже в качестве URL-адреса веб-службы на странице Параметры API.
После импорта можно добавить, изменить, переименовать или удалить операции в спецификации.Включение параметров запроса в шаблоны операций Установлен (по умолчанию) Указывает, следует ли импортировать необходимые параметры запроса в спецификацию в качестве параметров шаблона в Управление API. Отображаемое имя После ввода URL-адреса спецификации OpenAPI Управление API заполняет это поле на основе JSON. Это имя отображается на портале разработчика. Имя После ввода URL-адреса спецификации OpenAPI Управление API заполняет это поле на основе JSON. Уникальное имя API. Description После ввода URL-адреса спецификации OpenAPI Управление API заполняет это поле на основе JSON. Необязательное описание API. Схема URL-адресов HTTPS Определяет, какие протоколы можно использовать для доступа к этому API. Суффикс URL-адреса API petstore Этот суффикс добавляется к основному URL-адресу службы "Управление API". Управление API различает API по их суффиксу. Поэтому у каждого API для заданного издателя суффикс должен быть уникальным. Теги Теги для упорядочивания API для поиска, группирования или фильтрации. Товары Unlimited Ассоциация из одного или нескольких API. На определенных уровнях экземпляр Управление API поставляется с двумя примерами продуктов: Starter и Unlimited. Вы публикуете API на портале разработчика, связав API с продуктом.
Вы можете включить несколько API в продукт и предложить подписки на продукты разработчикам на портале разработчиков. Чтобы добавить этот API в другой продукт, введите или выберите название продукта. Повторите этот шаг, чтобы добавить API в несколько продуктов. Вы также можете добавить API в продукты позже на странице Параметры.
Дополнительные сведения о продуктах см. в статье Создание и публикация продукта.Шлюзы Управляемый Шлюзы API, которые предоставляют API. Это поле доступно только в службах уровня Разработка и Премиум.
Управляемый обозначает шлюз, встроенный в службу управления API и размещенный корпорацией Майкрософт в Azure. Локальные шлюзы доступны только в службах уровня "Разработка" и "Премиум". Вы можете развернуть их локально или в других облаках.
Если шлюзы не выбраны, API не будет доступен и запросы к API не будут выполнены.Версия этого API Установите или снимите флажок Дополнительные сведения см. в статье Публикация нескольких версий API предсказуемым способом. Щелкните Создать, чтобы создать API.
Если вы столкнулись с проблемами при импорте определения API, см. список известных проблем и ограничений.
Проверка нового API на портале Azure
Операции API можно вызывать напрямую на портале Azure. Это удобный способ просмотра и проверки операций. По умолчанию в тестовой консоли портала api вызываются с помощью ключа из встроенной подписки на все доступ. Вы также можете протестировать вызовы API с помощью ключа подписки, ограниченного для продукта.
В левой области навигации экземпляра Управление API выберите API>Swagger Petstore.
Выберите вкладку "Тест" и выберите " Найти домашних животных по состоянию". На странице показан параметр запроса состояния. Выберите одно из доступных значений, например ожидающих. Здесь также можно добавить параметры запроса и заголовки.
В разделе HTTP-запроса заголовок Ocp-Apim-Subscription-Key заполняется автоматически для вас, который можно увидеть, если выбрать значок "глаз".
Выберите Отправить.
Служба серверной части вернет ответ 200 — ОК и другие данные.
Следующие шаги
Из этого руководства вы узнали, как:
- импорт API;
- проверка API на портале Azure;
Перейдите к следующему учебнику, чтобы узнать, как создать и опубликовать продукт: