Упражнение. Создание подписок в службе управления API Azure

10 мин

Используйте пользовательский интерфейс службы управления API Azure на портале Azure, чтобы создавать подписки и получать ключи подписки для использования в клиентских приложениях.

Предположим, что ваша метеорологическая компания решила предоставлять метеорологические данные клиентам, которые оплачивают подписку. Важным требованием является предоставление доступа только клиентам, которым предоставлен ключ. Как ведущий разработчик вы должны создать шлюз API. Шлюз будет использоваться для публикации RESTful Weather API, который предоставляет конечную точку OpenAPI. Затем вы защитите конечную точку и выделите ключ клиента.

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

Публикация RESTful Weather API с данными о погоде.
Развертывание шлюза управления API.
Предоставление Weather API через конечную точку шлюза.
Ограничение доступа на основе ключа подписки.

Внимание

Для выполнения этого упражнения вам нужна собственная подписка Azure. При этом с вас может взиматься плата. Если у вас еще нет подписки Azure, создайте бесплатную учетную запись, прежде чем начинать работу.

Развертывание веб-API Weather

Вы разработали приложение .NET Core, которое возвращает информацию о погоде. Это приложение включает пакет Swashbuckle, который создает документацию OpenAPI.

Чтобы сэкономить время, мы выполним скрипт для размещения API в Azure. Скрипт выполняет следующие задачи.

создает план службы приложений Azure с ценовой категорией "Бесплатный";
создает веб-API в службе приложений Azure, настроенный для развертывания из локального репозитория GIT;
настраивает учетные данные развертывания на уровне учетной записи для приложения;
настраивает локальный репозиторий GIT;
развертывает веб-API в экземпляре службы приложений.

Войдите на портал Azure.
На панели задач Azure щелкните значок Cloud Shell, чтобы открыть Azure Cloud Shell.
Выполните в Azure Cloud Shell приведенную ниже команду git clone, чтобы клонировать репозиторий, содержащий исходный код приложения, и скрипт установки из GitHub.
```
git clone https://github.com/MicrosoftDocs/mslearn-control-authentication-with-apim.git
```
Перейдите в папку локального репозитория, выполнив приведенную ниже команду cd.
```
cd mslearn-control-authentication-with-apim
```
Как ясно из имени файла, setup.sh — это скрипт для создания API. Будет создано общедоступное веб-приложение, которое предоставляет интерфейс OpenAPI.
```
bash setup.sh
```
Этот скрипт состоит из 7 частей, а его выполнение занимает около минуты. Обратите внимание, что во время развертывания в удаленной службе приложений автоматически устанавливаются все зависимости, необходимые для выполнения приложения.

Выполнение скрипта завершается выводом двух URL-адресов: URL-адреса Swagger и примера URL-адреса. Эти URL-адреса можно использовать для тестирования развертывания приложения.
Чтобы проверить, правильно ли развернуто приложение, скопируйте URL-адрес Swagger в выходных данных Azure Cloud Shell и вставьте его в адресную строку в браузере. В браузере должен открыться пользовательский интерфейс Swagger нашего приложения с объявлением следующих конечных точек RESTful:
- api/weather/{latitude}/{longitude}, который возвращает метеорологические данные за текущий день на указанной широте и долготе (двойные значения).
- api/weather/{date}/{latitude}/{longitude}, который возвращает метеорологические данные за указанный день (значение даты) на указанной широте и долготе (двойные значения).
Наконец, скопируйте и сохраните пример URL-адреса из выходных данных Azure Cloud Shell. Это расположение является URL-адресом в формате JSON для Swagger. Он понадобится вам позже в этом упражнении.

Развертывание шлюза API

На следующем шаге в этом упражнении будет создан шлюз API на портале Azure. Этот шлюз будет использоваться в следующем упражнении для публикации API.

Войдите на портал Azure.
В меню ресурсов Azure или на домашней странице в службах Azure выберите "Создать ресурс". Откроется панель Создание ресурса.
В меню ресурсов выберите "Интеграция" и в результатах выберите Управление API. Откроется панель Установка шлюза службы "Управление API".

На вкладке Основные сведения введите указанные ниже значения для каждого параметра.

Параметр	Значение
Сведения о проекте
Отток подписок	Выберите свою подписку.
Группа ресурсов	Выберите новую или существующую группу ресурсов. Группа ресурсов — это логический контейнер, содержащий связанные ресурсы для решения Azure.
Сведения об экземпляре
Область/регион	Выберите доступный регион.
Имя ресурса	Введите `apim-WeatherData<random number>`; случайное число гарантирует, что имя будет глобально уникальным. Запишите имя этого ресурса; оно будет использоваться как имя шлюза API и понадобится вам позже в этом упражнении.
имя рабочей области.	Введите `Weather-Company`.
Адрес электронной почты администратора	Адрес электронной почты для получения всех системных уведомлений.
Ценовая категория
Ценовая категория	В раскрывающемся списке выберите `Consumption`.

Выберите Проверка и создание, а после завершения проверки нажмите Создать.

Примечание.

Уровень потребления обеспечивает быстрое развертывание для тестирования и имеет модель ценообразования на оплату за использование. Общий интерфейс управления API похож на другие ценовые категории.

Вы можете просмотреть ход развертывания, а также создаваемые ресурсы.

Импорт API

После завершения развертывания импортируйте API Погоды в шлюз Управления API с помощью следующей процедуры.

Выберите Перейти к ресурсу. Откроется панель обзора службы Управление API для вашего ресурса.
В левой панели меню в разделе Интерфейсы API выберите Интерфейсы API. Появится панель API для вашей службы "Управление API" с выбором шаблонов для создания и отображения API.
В разделе Создание из определения выберите OpenAPI. Откроется диалоговое окно Создание из спецификации OpenAPI.
В поле Спецификация OpenAPI вставьте URL-адрес JSON Swagger, сохраненный ранее в упражнении. По нажатию клавиши Ввод или при выборе другой области диалогового окна другие поля будут заполнены за вас. Эти данные импортированы из спецификации OpenAPI, созданной Swagger.
Примите значения по умолчанию для всех остальных параметров и выберите Создать.

На вкладке "Конструирование" API данных о погоде отображаются все операции, которые состоят из двух операций GET.

Добавление ключа подписки для доступа к Weather API

Последним шагом является добавление ключа подписки для API данных о погоде.

В левой области меню в разделе Интерфейсы API выберите Подписки. Откроется панель Подписки для вашей службы "Управление API".
В верхней строке меню выберите Добавить подписку. Откроется панель Создать подписку.

Введите указанные ниже значения для каждого параметра.

Параметр	Значение
Имя.	`weather-data-subscription`
Показать имя	`Weather Data Subscription`
Разрешить трассировку	Флажок отсутствует
Область	В раскрывающемся списке выберите API.
API	В раскрывающемся списке выберите Данные о погоде.

Нажмите кнопку создания. Панель Подписки содержит две подписки: встроенную подписку с доступом ко всем данным и подписку на данные о погоде.
В конце строки Подписка на данные о погоде выделите многоточие и в контекстном меню выберите Показать или скрыть ключи. Отображаются значения первичного и вторичного ключей.
Скопируйте в буфер обмена первичный ключ из подписки на метеорологические сведения и сохраните его в Блокноте или подобном приложении. Этот ключ понадобится на следующем шаге.

Тестирование ключа подписки

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