Запуск и запуск платформы Gravitee.io API Management на локальном компьютере

Если вы новичок в Gravitee.io, вы можете попробовать получить практический опыт работы с продуктом. В этом сообщении блога мы покажем вам, как быстро и легко настроить и запустить платформу Gravitee.io API Management (APIM) на вашем локальном компьютере с помощью Docker, а также развернуть ваш первый API.

Настройка APIM

В этом посте мы собираемся выполнить пошаговый процесс настройки и запуска API Management на вашем локальном компьютере, используя доступный файл Docker Compose со страницы загрузки. Оттуда мы собираемся запустить наш самый первый API, основанный на примере Swagger Petstore. Как всегда, если у вас есть какие-либо вопросы, обращайтесь на наш форум сообщества.

Если вы еще этого не сделали, вам нужно установить Docker. Я работаю на компьютере с Windows, поэтому я буду использовать Подсистему Windows для Linux (WSL) для запуска контейнера Gravitee Docker.

После того, как вы все настроите, мы собираемся загрузить APIM Gravitee.io Docker Compose file. Во-первых, убедитесь, что у вас запущена и работает командная строка (например, на вашем компьютере с Linux/Mac или WSL на Windows). Далее мы собираемся загрузить его с помощью curl, поэтому сначала перейдите в выбранный вами каталог, а затем выполните следующую команду:

curl https://raw.githubusercontent.com/gravitee-io/gravitee-docker/master/apim/3.x/docker-compose.yml -o docker-compose.yml

Если вы получили сообщение об ошибке, возможно, у вас нет прав на запись в выбранный вами каталог — внесите необходимые изменения.

После загрузки мы собираемся использовать файл компоновки докера для загрузки и запуска всех компонентов, необходимых для APIM. Мы можем сделать это, выполнив следующую команду:

docker-compose up

В зависимости от вашего интернет-соединения это может занять некоторое время, так как все соответствующие компоненты загружаются и устанавливаются на ваш компьютер. Следите за консолью, пока не увидите, что шлюзы/консоли регистрируют сообщения.

Вот и все! Теперь мы готовы к работе. Давайте теперь посмотрим на следующую часть этого поста, где мы развертываем API в Gravitee.io API Gateway.

Развертывание вашего первого API

Сначала мы перейдем к консоли управления APIM, чтобы иметь возможность создать и развернуть наш первый API. Для доступа к консоли перейдите по следующему адресу: http://localhost:8084

Учетные данные по умолчанию:

  • Имя пользователя: админ
  • Пароль: админ

После входа в систему вас встретит панель управления консолью. В следующем посте мы более подробно расскажем о консоли, а пока давайте запустим и запустим этот первый API!

Сначала нажмите «API». Это вызовет список существующих API, а также возможность создать новый. Поскольку мы создаем новый, нажмите на (+):

Появится панель Design Studio. Нам доступно два варианта:

  • Импорт позволяет нам создавать настройки API на основе существующей спецификации API.
  • Create позволяет нам создавать настройки API с нуля.

Мы собираемся использовать существующую спецификацию API. В этом примере мы будем использовать Пример Swagger PetStore API. Загрузите копию и нажмите Импорт, а затем Выбрать файл на следующем экране:

После выбора файла вам будут доступны некоторые дополнительные параметры. Опять же, в следующем сообщении в блоге мы рассмотрим более подробно, но сейчас убедитесь, что у вас также выбраны обведенные параметры:

  • «Создать политики по пути» — этот параметр создаст каждую конечную точку и связанные с ней методы на основе импортированного файла swagger.
  • «Применить фиктивные политики» — этот параметр создаст фиктивную политику для каждой конечной точки на основе примеров, представленных в импортированном файле swagger.

Затем нажмите импорт:

Появится экран с параметрами для настройки вашего API. Не беспокойтесь о золотой полосе «API не синхронизирован, разверните свой API», у нас есть ряд вещей, которые нужно сделать в первую очередь.

Чтобы иметь возможность протестировать наш API, нам нужно создать план. Всегда необходимо создавать план, который дает нам возможность контролировать доступ к API. Для этого примера мы собираемся создать план без ключа — это позволит любому получить доступ к API. Выберите «Планы», появится окно «Планы»:

Чтобы добавить новый план, нажмите (+). Затем укажите имя и описание плана, прокрутите вниз и нажмите «Далее»:

На следующем экране выберите «Без ключа (общедоступный)» в раскрывающемся меню «Тип аутентификации»:

Продолжайте нажимать «Далее», пока не завершите процесс создания плана. Теперь нам нужно опубликовать план, чтобы его можно было использовать. Щелкните изображение облака со стрелкой, указывающей вверх:

Остался последний шаг — запустить API. Перейдите в «Подробности» в разделе «Общие», прокрутив вниз до «Опасной зоны». Выберите «ЗАПУСТИТЬ API». Это синхронизирует развертывание API и связанного с ним плана, а также запуск самого API.

Перейти к шлюзу

Теперь, когда мы развернули API, давайте проверим его на Gravitee.io APIM Gateway.

Адрес шлюза доступен через порт 8082. Теперь мы собираемся вызвать одну из конечных точек из Swagger Petstore, которая будет возвращать фиктивные данные с использованием автоматически созданной политики при импорте файла Swagger:

http://localhost:8082/v2/pet/petid

Успех! Если хотите, почему бы не попробовать вызвать некоторые другие конечные точки, перечисленные в файле Swagger Petstore, или, в качестве альтернативы, попробовать импортировать другой файл определения API и выполнить описанный выше процесс.

Подведение итогов

В этом сообщении блога мы рассмотрели, как настроить и запустить платформу Gravitee APIM с помощью доступного файла Docker Compose. Кроме того, мы также увидели, как можно настроить и запустить API, а также протестировать его. Мы хотели бы знать, как вы поживаете! Если у вас есть какие-либо вопросы, обращайтесь на наш форум сообщества.