Упражнение. Создание внутреннего API
В этом упражнении вы узнаете, как выполнить следующие действия:
- создание экземпляра службы "Управление API" (APIM);
- Импорт API
- Настройка параметров серверной части
- Проверка API
Необходимые компоненты
- Учетная запись Azure с активной подпиской. Если у вас еще нет подписки, зарегистрируйтесь для получения бесплатной пробной версии по адресу https://azure.com/free .
Вход в Azure
Войдите в портал Azure и откройте Cloud Shell.
После открытия оболочки обязательно выберите среду Bash .
Создание экземпляра управления API
Давайте настроим некоторые переменные для команд интерфейса командной строки, которые используются для сокращения объема ручного ввода. Замените
<myLocation>
на подходящий вам регион. Имя APIM должно быть глобально уникальным именем, и следующий скрипт создает случайную строку. Замените<myEmail>
на адрес электронной почты, к которому у вас есть доступ.myApiName=az204-apim-$RANDOM myLocation=<myLocation> myEmail=<myEmail>
Создать группу ресурсов. Следующие команды создают группу ресурсов с именем az204-apim-rg.
az group create --name az204-apim-rg --location $myLocation
Создайте экземпляр APIM. Команда
az apim create
используется для создания экземпляра. Параметр--sku-name Consumption
используется для ускорения процесса в ходе этого руководства.az apim create -n $myApiName \ --location $myLocation \ --publisher-email $myEmail \ --resource-group az204-apim-rg \ --publisher-name AZ204-APIM-Exercise \ --sku-name Consumption
Примечание.
Операция должна завершиться примерно через пять минут.
Импорт API серверной части
В этом разделе показано, как импортировать и опубликовать API серверной части "Спецификация OpenAPI".
На портале Azure найдите и выберите Службы управления API.
На экране Управление API выберите созданный экземпляр службы "Управление API".
В области навигации службы управления API в разделе API выберите API.
Выберите OpenAPI из списка, а затем в раскрывающемся списке выберите пункт Полный.
Используйте значения из следующей таблицы, чтобы заполнить форму. Для тех полей, которые не указаны в таблице, можно оставить значения по умолчанию.
Параметр значение Описание Спецификация OpenAPI https://bigconference.azurewebsites.net/
Ссылается на службу, реализующую API, запросы перенаправляются по этому адресу. Большинство информации, которую необходимо указать в форме, заполняется автоматически после ввода значения этого параметра. Отображаемое имя API большой конференции Это имя отображается на портале разработчика. Имя big-conference-api Содержит уникальное имя API. Description Заполняется автоматически Необязательное описание API. Нажмите кнопку создания.
Настройка параметров API
Создается API большой конференции. Настройте параметры API.
Выберите "Параметры " в колонке справа.
Убедитесь, что
https://bigconference.azurewebsites.net/
находится в поле URL-адреса веб-службы.Снимите флажок Требуется подписка.
Выберите Сохранить.
Проверка API
Теперь, когда API был импортирован и настроен, пришло время протестировать API.
Выберите Тест.
Выберите Speakers_Get. На странице будут показаны параметры запроса и заголовки, если они есть.
Выберите Отправить.
Служба серверной части вернет ответ 200 — ОК и другие данные.
Очистка ресурсов Azure
После завершения работы с ресурсами, созданными в этом упражнении, можно использовать следующую команду, чтобы удалить группу ресурсов и все связанные ресурсы.
az group delete --name az204-apim-rg