С помощью этого руководства вы создадите по одному из путей заглушку API для тестирования проекта. Заглушка отдает указанный ответ на запрос по данному URI вместо ответа от целевого хоста.
Также вы научитесь запрашивать аутентификацию при отправке запросов к шлюзу. Доступ предоставляется только пользователям, у которых в качестве способа авторизации используется IAM-токен.
Вы будете использовать следующие сервисы:
Evolution API Gateway для создания API-шлюзов и политик маршрутизации с авторизацией пользователей из сети общего пользования.
Postman — инструмент для проектирования, тестирования, документирования и разработки API.
Шаги:
1. Создайте Mock API-шлюз
В личном кабинете перейдите в Разработка → API Gateway.
Откройте раздел Shared.
Нажмите Создать шлюз.
Отобразится окно создания шлюза.
По умолчанию шлюзу назначается системный адрес вида <uuid>.apigw.cloud.ru.
Укажите название шлюза.
Выберите для шлюза шаблон Mock-сервер.
Нажмите Продолжить.
Задайте URI для проксирования.
Пример:
Системный адрес: https://bc8296eda9dc4f2ba3a301ac411a32d8.apigw.cloud.ru.
URI для проксирования: /service1.
Для отправки запросов к бэкенду через шлюз будет использоваться адрес https://bc8296eda9dc4f2ba3a301ac411a32d8.apigw.cloud.ru/service1.
Укажите Статус ответа — 404.
Выберите Тип ответа — JSON.
Укажите JSON:
{"userId": 1,"id": 1,"title": "This is test response for success 404","completed": false}Нажмите Продолжить.
Автоматически будет создано правило, которое при успешном обращении по URI /service1 будет возвращать статус ответа 404 и JSON:
{"userId": 1,"id": 1,"title": "This is test response for success 404","completed": false}На этапе Политики, не добавляя политик, нажмите Создать.
Будет создан шлюз с одним активным правилом для всех HTTP-методов и URI /service1. При обращении по адресу шлюза с URI /service1 будет возвращаться заглушка с кодом ответа 404 и JSON-файлом в теле ответа.
2. Протестируйте шлюз в Test API
В личном кабинете перейдите в Разработка → API Gateway.
Откройте раздел Shared.
Откройте API-шлюз, созданный на шаге 2.
Разрешите кросс-доменные запросы для URI, указанного в правиле:
На вкладке Правила найдите правило, созданное на Шаге 2, и в контекстном меню выберите Редактировать.
В открывшемся мастере редактирования правила перейдите на шаг Политики.
Добавьте политику CORS.
В политике оставьте во всех полях значения *.
Нажмите Сохранить.
Теперь вы сможете протестировать запросы к правилу с помощью Test API.
Выполните запрос GET.
Сервер вернет ответ, установленный как заглушка при успешном запросе:
{"userId": 1,"id": 1,"title": "This is test response for success 404","completed": false}
3. Добавьте в правило политику авторизации по IAM-токену
Откройте рабочую область API Gateway: Разработка → API Gateway → Shared.
Откройте API-шлюз, созданный на шаге 1.
На вкладке Правила найдите правило, созданное на шаге 1, и в контекстном меню выберите Редактировать.
В мастере редактирования перейдите на шаге Политики нажмите Добавить политику.
Выберите Авторизация.
В окне Авторизация укажите IAM-токен.
Закройте окно Авторизация.
Нажмите Создать.
Шлюз будет обновлен.
При обращении к шлюзу будет запрашиваться авторизация по IAM-токену.
Для вызова используйте метод (например, «GET») и URL созданного API-шлюза, например — https://bc8296eda9dc4f2ba3a301ac411a32d8.apigw.cloud.ru/service1.
4. Получите токен авторизации
Создайте персональные ключи доступа или создайте сервисный аккаунт и для него ключи доступа сервисного аккаунта.
В Postman с помощью ключей доступа получите токен авторизации.
5. Протестируйте работу Mock API-шлюза в Postman
В Postman выполните запрос:
curl -X 'GET' \'https://bc8296eda9dc4f2ba3a301ac411a32d8.apigw.cloud.ru/service1' \-H 'accept: text/plain' \--header 'Authorization: Bearer <access_token>' \
Где:
bc8296eda9dc4f2ba3a301ac411a32d8.apigw.cloud.ru — пример системного домена вашего API-шлюза;
/service1 — пример URI правила;
<access_token> — токен авторизации, полученный на предыдущем шаге.
В ответ на запрос придет результат, установленный как заглушка:
Результат
Вы создали новый API-шлюз с Mock-сервером и авторизацией по IAM-токену и протестировали его онлайн.