Создайте RESTful API в Go с помощью AWS Lambda

В этом посте мы научимся проектировать, создавать и развертывать RESTful API в Go с использованием AWS Lambda. Прежде чем начать, позвольте мне кратко рассказать о AWS Lambda.

Что такое AWS Lambda?
AWS Lambda — это серверная вычислительная служба, которая запускает наш код в ответ на события и автоматически управляет базовыми вычислительными ресурсами для нас. Мы можем использовать AWS Lambda для расширения других сервисов AWS с помощью собственной логики или для создания собственных внутренних сервисов, которые работают с масштабом, производительностью и безопасностью AWS. AWS Lambda может автоматически запускать код в ответ на несколько событий, таких как HTTP-запросы через Amazon API Gateway, изменения объектов в корзинах Amazon S3, обновления таблиц в Amazon DynamoDB и переходы состояний в пошаговых функциях AWS.

Lambda запускает наш код в вычислительной инфраструктуре высокой доступности и выполняет все администрирование вычислительных ресурсов, включая обслуживание сервера и операционной системы, выделение ресурсов и автоматическое масштабирование, развертывание кода и исправлений безопасности, а также мониторинг и ведение журнала. Все, что нам нужно сделать, это предоставить код.

Теперь давайте начнем с создания API, которое поможет местному магазину проката фильмов управлять имеющимися фильмами.

Архитектура API

Следующая диаграмма показывает, как API Gateway и Lambda вписываются в архитектуру API:

AWS Lambda расширяет возможности микросервиса. При этом каждая конечная точка запускает отдельную лямбда-функцию. Эти функции независимы друг от друга и могут быть написаны на разных языках, что приводит к масштабированию на уровне функций, упрощению модульного тестирования и слабой связи.

Все запросы от клиентов сначала проходят через шлюз API. Затем он направляет входящий запрос в правую лямбда-функцию соответственно.

Обратите внимание, что одна лямбда-функция может обрабатывать несколько методов HTTP ( GET , POST , PUT , DELETE и т. Д.). Рекомендуется создать несколько функций Lambda для каждой функции, чтобы использовать возможности микросервисов. Однако создание одной лямбда-функции для обработки нескольких конечных точек может быть хорошим упражнением.

Дизайн конечных точек

Теперь, когда архитектура определена, пришло время приступить к реализации функций, описанных на диаграмме выше. Вместо жесткого кодирования кода состояния HTTP вы можете использовать пакет net / http Go и использовать встроенные переменные кода состояния, такие как http.StatusOK , http.StatusCreated , http.StatusBadRequest , http.StatusInternalServerError и так далее.

Метод GET

Первая функция, которую нужно реализовать, — это перечисление фильмов. Вот где метод GET вступает в игру. Давайте начнем с следующих шагов:

Шаг 1: Создайте лямбда-функцию, которая регистрирует обработчик findAll . Этот обработчик преобразует список фильмов в строку, а затем возвращает эту строку, заключенную в переменную APIGatewayProxyResponse, вместе с кодом состояния HTTP 200 . Он также обрабатывает ошибки в случае сбоя преобразования. Реализация обработчика выглядит следующим образом:

Вместо жесткого кодирования кода состояния HTTP вы можете использовать пакет net / http Go и использовать встроенные переменные кода состояния, такие как http.StatusOK , http.StatusCreated , http.StatusBadRequest , http.StatusInternalServerError и так далее.

Шаг 2. Создайте файл сценария со следующим содержимым для создания пакета развертывания функции Lambda, ZIP- файл, состоящий из вашего кода и любых зависимостей, следующим образом:

Шаг 3. Выполните следующие команды, чтобы создать пакет развертывания в виде файла .zip :

Шаг 4. Настройте интерфейс командной строки AWS, используя шаги, упомянутые здесь . После настройки создайте роль AWS с именем FindAllMoviesRole, выполнив шаги, упомянутые здесь, и проверьте, успешно ли она создана:

Выше команда должна дать ответ, как показано на скриншоте ниже:

Шаг 5. Затем создайте новую функцию Lambda с помощью интерфейса командной строки AWS следующим образом:

Как только функция создана, она выдаст нам вывод, такой же, как показано на скриншоте ниже:

Шаг 6. Возвращаясь к лямбда-консоли AWS, вы должны увидеть, что функция была успешно создана:

Шаг 7. Создайте пример события с пустым JSON, так как функция не ожидает аргументов, и нажмите кнопку « Тест» :

На предыдущем снимке экрана вы заметите, что функция возвращает ожидаемый результат в формате JSON.

Шаг 8: Теперь, когда функция была определена, вам нужно создать новый шлюз API, чтобы запустить его:

Шаг 9: Далее в раскрывающемся списке « Действия» выберите « Создать ресурс» и назовите его « фильмы» :

Шаг 10: Откройте метод GET для этого ресурса / videos , нажав « Создать метод» . Выберите Лямбда-функцию в разделе Тип интеграции и выберите функцию FindAllMovies :

Шаг 11. Для развертывания API выберите Deploy API в раскрывающемся списке Actions . Вам будет предложено создать новый этап развертывания:

Шаг 12. После создания этапа развертывания будет отображен URL-адрес вызова:

Шаг 13: Направьте ваш браузер на указанный URL или используйте современный клиент REST, такой как Postman или Insomnia. Вы можете использовать инструмент cURL , так как он установлен по умолчанию практически во всех операционных системах:

Приведенная выше команда вернет список фильмов в формате JSON:

При вызове конечной точки GET запрос будет проходить через шлюз API, который вызовет обработчик findAll . Это возвращает ответ, переданный через шлюз API клиенту в формате JSON.

Теперь, когда функция findAll была развернута, вы можете реализовать функцию findOne для поиска фильма по его идентификатору.

Метод GET с параметрами

Обработчик findOne ожидает аргумент APIGatewayProxyRequest, который содержит входные данные события. Затем он использует метод PathParameters, чтобы получить идентификатор фильма и проверить его.

Если предоставленный идентификатор не является действительным числом, метод Atoi вернет ошибку, и код ошибки 500 будет возвращен клиенту. В противном случае фильм будет выбран на основе индекса и возвращен клиенту со статусом 200 OK, завернутым в APIGatewayProxyResponse :

Аналогично функции FindAllMovies создайте новую лямбда-функцию для поиска фильма:

Вернитесь в консоль API Gateway, создайте новый ресурс, откройте метод GET , а затем свяжите ресурс с функцией FindOneMovie . Обратите внимание на использование заполнителя {id} в пути. Значение id будет доступно через объект APIGatewayProxyResponse . Следующий скриншот изображает это:

Повторно разверните API и используйте следующую команду cURL для проверки конечной точки:

Будет возвращен следующий JSON:

Когда URL API вызывается с идентификатором, возвращается фильм, соответствующий этому идентификатору, если он существует.

Метод POST

Теперь вы знаете, как работает метод GET с параметрами пути и без них. Следующим шагом является передача полезной нагрузки JSON в функцию Lambda через шлюз API. Код не требует пояснений. Он преобразует входные данные запроса в структуру фильма, добавляет его в список фильмов и возвращает новый список фильмов в формате JSON:

Затем создайте новую лямбда-функцию для InsertMovie с помощью следующей команды:

Затем создайте метод POST для ресурса / movies и свяжите его с функцией InsertMovie :

Чтобы проверить это, используйте следующую команду cURL с глаголом POST и флагом -d , за которым следует строка JSON (с атрибутами id и name):

Приведенная выше команда вернет следующий ответ JSON:

Как видите, новый фильм успешно вставлен. Если вы протестируете это снова, оно должно работать как ожидалось

Предыдущая команда вернет следующий ответ JSON:

Как видите, он был успешным, и фильм снова был вставлен, как и ожидалось, но что если подождать несколько минут и попытаться вставить третий фильм? Следующая команда будет использована для ее повторного выполнения:

Еще раз, новый ответ JSON будет возвращен:

Вы обнаружите, что фильмы с идентификаторами 6 и 7 были удалены; почему это случилось? Это просто. Лямбда-функции не имеют состояния.

Когда функция InsertMovie вызывается впервые (первая вставка), AWS Lambda создает контейнер и развертывает полезную нагрузку функции в контейнер. Затем он остается активным в течение нескольких минут до его завершения ( горячий запуск ), что объясняет, почему прошла вторая вставка. В третьей вставке контейнер уже завершен, и, следовательно, Lambda создает новый контейнер ( холодный старт ) для обработки вставки.

Вот почему предыдущее состояние потеряно. Следующая диаграмма иллюстрирует проблему холодного / теплого старта:

Это объясняет, почему лямбда-функции не должны иметь состояния и почему вы не должны делать никаких предположений о том, что состояние будет сохраняться от одного вызова к другому.

Полный исходный код размещен на github .