Проектирование безопасности API
В рамках процесса проектирования API необходимо указать, какие потребители могут получать доступ к вашему API (аутентификация) и что им разрешено делать (авторизация).
Вы можете просто определить общую безопасность для всего API или выбрать более тонкую политику с определенной безопасностью для критически важного ресурса.
Вы также можете указать, что определенные операции находятся в свободном доступе без аутентификации.
API Designer
может обрабатывать все эти случаи с помощью основных типов безопасности:
- Базовая аутентификация
- Аутентификация Bearer
- Дайджест-аутентификация
- OAuth 1.0
- OAuth 2.0
- OpenID Connect
- Пользовательский / ключ API
- Сквозная (Pass through)
Аутентификация с помощью файлов cookie не поддерживается.
Создание схемы безопасности
Создайте схему безопасности для глобального использования в вашей версии API или в отдельных элементах.
- Введите другие параметры, специфичные для выбранного типа.
Ваша схема безопасности теперь создана, вы можете использовать ее в глобальных настройках вашего API или в определенных ресурсах и операциях.
Определение безопасности вашего API
Определите схемы безопасности для вашего API, ресурсов и операций.
- В разделе Глобальная безопасность добавьте свои схемы безопасности и выберите те, которые вы хотите применить глобально к вашей версии API.
- Выберите ресурс и выберите схемы безопасности, которые вы хотите применить ко всем операциям вашего ресурса.
В качестве альтернативы вы можете выбрать операцию, чтобы определить ее конкретную безопасность.
