Управление API и эффективность операционных процессов
Узнайте, как использовать Управление API для публикации API-интерфейсов для внешних, партнерских и корпоративных разработчиков безопасно и в нужном масштабе. Эта сетевая служба является гибридной мультиоблачной платформой управления для интерфейсов API во всех средах.
Возможные компоненты:
Дополнительные сведения см. в статье Сведения об Управлении API.
Чтобы понять, как Управление API обеспечивает эффективность операционных процессов, ознакомьтесь со следующими разделами:
- Сведения об управлении службой "Управление API" с помощью службы автоматизации Azure
- Наблюдаемость в службе "Управление API Azure"
Контрольный список
Вы настроили Управление API с учетом эффективности операционных процессов?
- Обеспечьте безопасность обмена данными между Управлением API и серверной частью.
- Убедитесь, что у каждой стороны есть свои учетные данные при предоставлении API третьим сторонам.
- Установите квоты и пределы скорости при предоставлении API третьим сторонам.
- Ознакомьтесь с руководством по проектированию и архитектуре Microsoft REST API.
- Включите управление версиями API для обеспечения обратной совместимости при добавлении других функций.
- Чтобы реализовать управление версиями API, используйте функции управления версиями и редакции Управления API.
- Изучите ограничения импорта API в Управлении API.
- Изучите функцию ведения журнала событий.
- Выполняйте трассировку вызовов в Управлении API Azure, чтобы упростить отладку и тестирование.
- Настройте ведение журнала с помощью Azure Monitor для службы управления API.
- Выберите правильные режимы для доступа к частным подключениям к сайту.
- Оцените правила брандмауэра и списки разрешенных IP-адресов на основе общедоступного IP-адреса Управления API.
Рекомендации по настройке
При настройке службы Управления API примите во внимание следующие рекомендации по эффективности операционных процессов:
| Рекомендация | Описание |
|---|---|
| Установите квоты и пределы скорости при предоставлении API третьим сторонам. | Защитите серверные службы и уменьшите нагрузку на единицу масштабирования Управления API. Политики ограничения скорости можно применять на глобальном уровне, уровне продукта, уровне API и уровне операций, чтобы обеспечить настройку ограничения скорости для потребителей API. |
| Ознакомьтесь с руководством по проектированию и архитектуре Microsoft REST API. | Применяйте стандарты и рекомендации при использовании REST API. Следующие рекомендации обеспечивают максимальную совместимость между платформами и реализациями. Ознакомьтесь с рекомендациями по REST API и проектированию API. |
| Изучите ограничения импорта API в Управлении API. | Для обеспечения бесперебойной работы процесса импорта API прилагаются все усилия, в том по отказу от дополнительной настройки. В некоторых сценариях применяются ограничения, которые потребует внесения изменений в источник импорта. Применяется как к службам REST, так и к службам SOAP. Текущие ограничения на импорт API см. в разделе Ограничения политики. |
| Изучите функцию ведения журнала событий. | Поддерживает ведение журнала событий в концентраторе событий Azure для выполнения анализа практически в реальном времени. Эта функция интегрируется с внешними журналами, решениями по управлению информационной безопасностью и событиями безопасности (SIEM) или анализом использования API практически в реальном времени. |
| Выполняйте трассировку вызовов в Управлении API Azure, чтобы упростить отладку и тестирование. | Трассировка должна быть включена в подписке, используемой для выполнения запроса. Трассировка включается для каждого запроса с использованием значения заголовка OCP-Apim-Trace. Трассировка API также встроена в портал администрирования и включена по умолчанию при тестировании API с портала. |
| Настройте ведение журнала с помощью Azure Monitor для службы управления API. | Журналы могут отправляться в рабочую область Log Analytics для сложных запросов и анализа. Для более долгосрочного анализа можно принимать метрики. После этого все данные отображаются с помощью Azure Monitor. Можно интегрировать Application Insights для управления производительностью приложений. |
| Выберите правильные режимы для доступа к частным подключениям к сайту. | Поддерживает интеграцию виртуальной сети во внутреннем и внешнем режиме. |
| Оцените правила брандмауэра и списки разрешенных IP-адресов на основе общедоступного IP-адреса Управления API. | Фиксированный общедоступный IP-адрес доступен в течение времени существования службы с планами Basic, Developer, Standard и Premium для Управления API. |