Руководство. Использование расширения Azure Управление API для Visual Studio Code для импорта API и управления ими
ОБЛАСТЬ ПРИМЕНЕНИЯ: Потребление | Разработчик | Базовый | Стандартный | Премия
В этом руководстве описано, как использовать расширение Управление API для Visual Studio Code для распространенных операций в Управление API. Для импорта, обновления, тестирования API и управления ими вы будете использовать знакомую среду Visual Studio Code.
Узнайте следующие темы:
- импорт API в Управление API;
- редактирование API;
- применение политик службы "Управление API";
- Проверка API
Общие сведения о дополнительных возможностях службы "Управление API" см. в руководствах по этой службе на портале Azure.
Необходимые компоненты
- Ознакомьтесь с терминологией службы "Управление API" в Azure.
- Убедитесь, что вы установили Visual Studio Code и последнее расширение Azure Управление API для Visual Studio Code.
- Создание экземпляра службы управления API Azure.
Импорт API
В следующем примере спецификация OpenAPI импортируется в формате JSON в службу "Управление API". В этом примере импортируется API открытый код Petstore.
- В Visual Studio Code на панели действий щелкните значок Azure.
- В области проводника разверните созданный экземпляр службы "Управление API".
- Щелкните элемент Интерфейсы API правой кнопкой мыши и выберите Import from OpenAPI Link (Импорт по ссылке OpenAPI).
- При появлении запроса введите следующие значения:
Ссылка на OpenAPI для содержимого в формате JSON. В этом примере:
https://petstore.swagger.io/v2/swagger.json
.Этот файл указывает серверную службу, реализующую пример API и поддерживаемые им операции.
Имя API, например petstore, уникальное в экземпляре Управление API. Это имя может содержать только буквы, цифры и дефисы. Первый и последний знаки должны быть буквой или цифрой. Это имя используется в пути для вызова API.
После успешного импорта интерфейс API отобразится в области проводника, а доступные операции API — в узле Operations (Операции).
редактирование API;
API можно редактировать в Visual Studio Code. Например, измените описание API Resource Manager в окне редактора, чтобы удалить протокол HTTP , используемый для доступа к API, который выделен в следующем фрагменте кода:
Чтобы изменить формат OpenAPI, в области проводника щелкните имя API правой кнопкой мыши и выберите Edit OpenAPI (Изменить OpenAPI). Внесите нужные изменения и щелкните Файл>Сохранить.
Применение политик к API
Служба "Управление API" предоставляет политики, которые можно настроить для интерфейсов API. Политики — это коллекция инструкций. Эти инструкции выполняются по очереди по запросу или в ответ API. Политики могут быть глобальными (то есть применяться ко всем API в экземпляре службы "Управление API") или могут быть ограничены определенным продуктом, API или операцией API.
В этом разделе показано, как применять к API общие политики входящего и исходящего трафика.
В области обозревателя выберите "Политика" в импортированном API хранилища домашних животных. Файл политики откроется в окне редактора. Этот файл позволяет настроить политику для всех операций в API.
Обновите файл со следующим содержимым:
<policies> <inbound> <rate-limit calls="3" renewal-period="15" /> <base /> </inbound> <outbound> <set-header name="Custom" exists-action="override"> <value>"My custom value"</value> </set-header> <base /> </outbound> <on-error> <base /> </on-error> </policies>
- Политика
rate-limit
вinbound
разделе ограничивает количество вызовов API каждые 15 секунд. - Политика
set-header
вoutbound
разделе добавляет пользовательский заголовок ответа для демонстрационных целей.
- Политика
Сохраните файл. При появлении запроса выберите Upload (Отправить), чтобы отправить файл в облако.
Проверка API
Чтобы протестировать API, получите ключ подписки и отправьте запрос на шлюз Управление API.
Получение ключа подписки
Чтобы протестировать импортированный API и примененные политики, вам потребуется ключ подписки для экземпляра службы "Управление API".
В области проводника щелкните имя экземпляра службы "Управление API" правой кнопкой мыши.
Выберите Copy Subscription Key (Копировать ключ подписки). Этот ключ предназначен для встроенной подписки доступа, созданной при создании экземпляра Управление API.
Внимание
Подписка all-access обеспечивает доступ к каждому API в этом Управление API экземпляре и должен использоваться только авторизованными пользователями. Никогда не используйте его для обычного доступа к API или внедрения ключа all-access в клиентских приложениях.
Тестирование операции API
- В области обозревателя разверните узел операций в импортированном API хранилища домашних животных .
- Выберите операцию, например [GET]Найти питомца по идентификатору, а затем щелкните правой кнопкой мыши операцию и выберите "Тестовая операция".
- В окне редактора замените
5
petId
параметр в URL-адресе запроса. - В окне редактора рядом с Ocp-Apim-Subscription-Key замените
{{SubscriptionKey}}
ключом подписки, который вы скопировали. - Щелкните Отправить запрос.
При успешном выполнении запроса серверная часть вернет ответ 200 — ОК и другие данные.
Обратите внимание на следующие сведения в ответе:
- В
Custom
ответ добавляется заголовок.
Теперь проверьте политику ограничения скорости. Нажмите кнопку "Отправить запрос несколько раз в строке". После отправки слишком большого количества запросов в настроенный период вы получите 429 Too Many Requests
ответ.
Обработка запроса трассировки
Кроме того, вы можете получить подробные сведения о трассировке запросов, чтобы помочь в отладке и устранении неполадок с API.
Инструкции по включению трассировки для API см. в разделе "Включение трассировки для API". Чтобы ограничить непреднамеренное раскрытие конфиденциальной информации, трассировка по умолчанию допускается только на 1 час.
Очистка ресурсов
Удалите экземпляр службы "Управление API", щелкнув правой кнопкой мыши и выбрав пункт Открыть на портале, чтобы удалить службу Управление API и связанную с ней группу ресурсов.
Кроме того, можно нажать кнопку Delete API Management (Удалить службу "Управление API"), чтобы удалить только экземпляр службы "Управление API" (без группы ресурсов).
Связанный контент
В этом руководстве представлено несколько функций расширения Управление API для Visual Studio Code. с помощью которых можно импортировать API и управлять ими. Вы научились выполнять следующие задачи:
- импорт API в Управление API;
- редактирование API;
- применение политик службы "Управление API";
- Проверка API
Расширение Управление API предоставляет дополнительные функции для работы с API. Например, политики отладки (доступные на уровне служб "Разработка") или создание именованных значений и управление ими.