Как да внедрите API без сървър с AWS SAM CLI & GitHub Actions

Разполагането на API с помощта на AWS Serverless Application Model (SAM) е ефективен и мащабируем подход за облачни приложения. Той опростява управлението на инфраструктурата, осигурява вградена SSL/TLS поддръжка и безпроблемно се интегрира с AWS услуги като CloudFormation, Lambda, S3, Route 53 и CloudWatch. Използвайки модел без сървър, разработчиците могат да се съсредоточат върху писането на логиката на приложенията, докато AWS се занимава с мащабиране, сигурност и поддръжка, което го прави идеално решение за съвременни API с висока наличност. Таблица на съдържанието – Въведение: Защо да използвате SAM за разгръщане на API? – Предварителни изисквания: Инсталиране на SAM CLI – Стъпка 1: Инициализиране на SAM – Стъпка 2: Определяне на API Endpoint – Стъпка 3: Създаване и тестване на място – Стъпка 4: Разполагане на API – Стъпка 5: CI / CD с Github действия – Заключение Intro: Защо да използвате SAM за разгръщане на API? Този урок ще ви напътства стъпка по стъпка как да създадете прост API, да го разгърнете с AWS CloudFormation с SAM CLI и след това да автоматизирате разгръщането с GitHub Actions. Ето по-подробна диаграма на този работен поток: Предварителни изисквания Предварителни изисквания за местно тестване. AWS CLI и SAM CLI инсталирани. Node.js инсталирани Docker акаунт. GitHub AWS CLI и SAM CLI са инсталирани. Node.js инсталиран Node.js инсталиран за локално тестване. Docker Документът акаунт. GitHub GitHub Предпоставки: Инсталирайте SAM CLI Преди да се потопите в урока, уверете се, че AWS SAM CLI е инсталиран на вашия компютър. По-долу са стъпките за инсталиране за macOS и Windows: За macOS (ако не сте го инсталирали вече): Инсталирайте Homebrew Инсталирайте Homebrew /bin/bash -c “$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" /bin/bash -c “$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" : Добавете клавиша AWS и инсталирайте SAM CLI Добавете AWS клавиша и инсталирайте SAM CLI aws/tapbrew install aws-sam-cli brew tap aws/tapbrew install aws-sam-cli Проверете инсталацията с sam --version sam - версия За Windows : Изтеглете инсталатора на SAM CLI Изтеглете инсталатора SAM CLI Отидете на и изтеглете последния инсталатор на Windows. официална страница на AWS SAM CLI Отидете на и изтеглете последния инсталатор на Windows. официална страница на AWS SAM CLI официална страница на AWS SAM CLI : Изпълнете инсталатора Изпълнете инсталатора Двойно щракнете върху изтегления файл и следвайте съветника за инсталиране. .exe Двойно щракнете върху изтегления файл и следвайте съветника за инсталиране. .exe .exe и Натиснете върху „Редактиране на променливите в системната среда“.Под „Свойства на системата“ щракнете върху бутона „Променливи на околната среда“. Добавете директорията, в която е инсталиран SAM CLI (напр. ). (ако не се добавя автоматично): Добавете SAM CLI към PATH Добавете SAM CLI към ПЪТ Отворете менюто Старт и потърсете "Променливи на околната среда". Кликнете върху "Редактиране на променливите на околната среда на системата." Под "Свойства на системата", кликнете върху бутона "Променливи на околната среда". В "Променливи на системата", намерете и кликнете върху "Edit." Path Добавете директорията, в която е инсталиран SAM CLI (напр. ). C:\Program Files\Amazon\AWS SAM CLI\bin Отворете менюто Старт и потърсете “Променливи на околната среда.” В “Системни променливи”, намерете и кликнете върху “Edit.” Path Пътят C:\Program Files\Amazon\AWS SAM CLI\bin C:\Program Files\Amazon\AWS SAM CLI\bin : Отворете команда и изпълнете Проверка на инсталацията sam --version Проверете инсталацията sam - версия Стъпка 1: Инициализиране на SAM CLI Създайте ново хранилище на вашата машина: mkdir aws-serverless-api Създаване на ново хранилище на вашата машина: aws-serverless-api от aws-serverless-api Навигация към директорията: cd aws-serverless-api Навигация към директорията: cd aws-serverless-api тогава ще бъдете подканени с няколко опции. Инициализирайте ново SAM приложение: sam init Инициализиране на ново SAM приложение: sam init Изберете “1 — AWS Quick Start Templates.“ Изберете за разгръщане на Lambda-backed serverless API на API Gateway.“ “7 — Serverless API” Изберете “Node.js 20.x” Изберете или „Не“ за X-Ray проследяване, тъй като искаме да намалим разходите си, и това е просто пример за Hello World. Ако правите сложен API, който се изтегля в различни услуги, може да искате да позволите това да помогне за “N” Изберете “1 — шаблони за бързо стартиране на AWS.” “1 — Шаблони за бързо стартиране на AWS.” “1 — Шаблони за бързо стартиране на AWS.” Изберете за да разгърнете безсървърна API, поддържана от Lambda, в API Gateway.“ “7 — Serverless API” “7 — API без сървър” “7 — API без сървър” Изберете “Node.js 20.x” “Node.js 20.x” „Node.js 20.x“ Изберете или Не за проследяване на рентгенови лъчи, тъй като искаме да намалим разходите си и това е просто прост пример за Hello World. "N" “N” „N“ Аз също така избирам за мониторинг на cloudwatch, тъй като не се нуждаем от анализ на производителността за този пример за Hello World. “N” “N” „N“ Също за формата json в лог lambda, тъй като това е само пример за Hello World. “N” “N” „N“ Сега, нека cd в директорията, която генерира; Аз избрах да назовем моя проект така че нека отидем: sam init sam-hello-world sam init Заглавие на текста Свържете се с нас Кодът е кодът. sam-hello-world CD слайд слайд слайд CD sam-hello-world След това отворете проекта във VSCode - когато отворите проекта във VSCode или любимия си IDE, вече трябва да видите много генерирани файлове. code. Разбиране на генерираните файлове Ето какво прави всеки от файловете, генерирани от : sam init sam init – Определя вашия API Gateway, Lambda и други ресурси на AWS. **template.yaml** – Съдържа образец на функцията Lambda. **src/handlers/** – Образец на тестови събития за местно тестване. **events/** – Управлява зависимостите за функциите на Node.js Lambda. **package.json** .gitignore** – Стандартни файлове за проекти. – Определя вашия API Gateway, Lambda и други AWS ресурси. **template.yaml** Заглавие на текста Кодът на кода Кодът **template.yaml** – Съдържа образец на функцията Lambda handlers. **src/handlers/** **src/handlers/** – Събития за изпитване на извадки за местни изпитвания. **events/** ** събития/** – Управлява зависимостите за Node.js Lambda функции. **package.json** **package.json** **.itignore** – Стандартни файлове за инсталиране на проекти. **README.md** **README.md** Ние ще . модифицираме и премахваме някои от тези файлове, за да се впишат в нашия много прост "Hello world" API модифицирайте и премахнете някои от тези файлове, за да отговарят на нашия много прост "Hello world" API Стъпка 2: Определяне на API Endpoint Сега отворете и заменете съществуващите дефиниции на функцията Lambda със следното: template.yaml заглавие на таблото.yaml AWSTemplateFormatVersion: "2010-09-09" Transform: AWS::Serverless-2016-10-31 Описание: AWS SAM шаблон за разполагане на Node.js/Express API в Lambda Ресурси: HelloWorldFunction: Type: AWS::Serverless::Function Properties: Handler: src/app.lambdaHandler Runtime: nodejs20.x Events: HelloWorld: Type: Api Properties: Path: / Method: GET AWSTemplateFormatVersion: "2010-09-09" Transform: AWS::Serverless-2016-10-31 Описание: AWS SAM шаблон за разполагане на Node.js/Express API в Lambda Ресурси: HelloWorldFunction: Type: AWS::Serverless::Function Properties: Handler: src/app.lambdaHandler Runtime: nodejs20.x Events: HelloWorld: Type: Api Properties: Path: / Method: GET Това определя един маршрут в корена на нашия API, който е GET заявка Актуализиране на функцията Lambda В директорията нека създадем файл, наречен /src app.js /src или app.js и В , нека напишем функция, за да изведем hello world от нашия маршрут: src/app.js src/app.js и exports.lambdaHandler = async (event) => { return { statusCode: 200, body: JSON.stringify({ message: "Hello, World!" }) }; }; exports.lambdaHandler = async (event) => { return { statusCode: 200, body: JSON.stringify({ message: "Hello, World!" }) }; }; Изтриване на ненужни файлове Сега нека премахнем допълнителните манипулатори и събития, които генерира в стъпка 1. sam init sam init Отворете терминал в директорията на проекта и : изпълнете следните команди изпълнете тези команди rm -rf src/handlers/get-all-items.mjs src/handlers/get-by-id.mjs src/handlers/put-item.mjs rm -rf src/handlers/get-all-items.mjs src/handlers/get-by-id.mjs src/handlers/put-item.mjs rm -rf събития/ rm -rf събития/ Стъпка 3: Създаване и тестване локално Отворете терминал в директорията на проекта и следвайте стъпките по-долу: : Създаване на приложение : Създаване на приложението Създаване на приложение трябва да видите изход като този: sam build трябва да видите изход като този: sam build sam build : Стартиране на локален API сървър : Стартиране на локален API сървър Стартиране на локален API сървър — Забележете, че ще трябва да имате инсталиран, за да изпълнявате това локално. Когато успеете, трябва да видите контейнер, създаден за нашия API в работния плот на докера. sam local start-api docker Отваряне на браузър или използване на в терминала, за да тествате крайната точка: curl curl [http://127.0.0.1:3000/] (http://127.0.0.1:3000 — Забележете, че ще трябва да имате инсталиран, за да изпълнявате това локално. Когато успеете, трябва да видите контейнер, създаден за нашия API в работния плот на докера. sam local start-api docker Отворете браузър или използвайте в терминала, за да тествате крайната точка: curl — Забележете, че ще трябва да имате инсталиран, за да изпълните това локално. Когато успеете, трябва да видите контейнер, създаден за нашия API в работния плот на докера. sam local start-api docker Заглавие на страницата Заглавие на кода: sam local start-api docker Отворете браузър или използвайте в терминала, за да тествате крайната точка: curl Отворете браузър или използвайте в терминала, за да тествате крайната точка: curl curl > Изтеглете Изберете името на вашия стак; моето е Заглавие на текста Потвърдете промените преди разполагане; Избрах И Разрешаване на SAM-CLI Role Creation, И curl [http://127.0.0.1:3000/](http://127.0.0.1:3000/) curl [http://127.0.0.1:3000/](http://127.0.0.1:3000/) Curl [http://127.0.0.1:3000/](http://127.0.0.1:3000/) Ако видите JSON, върнат от нашата крайна точка, тогава успешно сте стартирали API локално! Стъпка 4: Разполагане на API : Сега, когато сме потвърдили, че нашият API работи локално, нека го разгърнем в AWS с Пакетиране и разгръщане на API с SAM Пакетиране и разгръщане на API с SAM sam разглобяване --guided sam deploy --guided Това ръководство за разполагане ще ви позволи да: Това ръководство за разполагане ще ви позволи да: sam-hello-world sam-hello-world 2. Изберете AWS регион; моят е us-east-1 американски_1 Y Y 5. деактивирайте Rollback, изберете искаме инструментът да почисти всички неизправени ресурси N N и И Запишете аргументите в конфигурационен файл И Конфигурационен файл 6. HelloWorldFunction няма удостоверяване; това е наред? За целите на това урок Y Y samconfig.toml samconfig.toml и 9. среда за конфигуриране на SAM — оставете това по подразбиране Ако разполагането ви е било успешно, трябва да видите ресурсите, които са били успешно създадени, както следва: Когато внедряването е успешно, и потърсете услугата API Gateway. Отидете в настройките на API, копирайте домейна си в URL входа на прозореца на браузъра си и добавете `/Prod` в края на URL адреса си, за да достигнете до крайната точка на разгърнатия API. Влезте в AWS акаунта си Влезте в акаунта си в AWS Моят URL адрес изглежда така: Можете също така да търсите Lambda в конзолата на AWS, за да прегледате разгърнатата функция Lambda без сървър, където живее кодът, който написахме за тази крайна точка. You should also see an S3 bucket created, which holds the bundle of our code. Now that we’ve successfully deployed our API, let’s automate this process with GitHub so that anytime we want to develop on our API, the deployment can automatically trigger by just committing to the MAIN or MASTER branch. Стъпка 5: CI/CD с Github действия Инициирайте Git Repo и натиснете към вашия господарски клон Първо, ние ще инициализираме git хранилище в директорията на нашия проект с След това нека добавим тези файлове към нашия , тъй като не искаме да ги ангажираме. git init .gitignore Git init и .заглавие echo "node_modules/\n.aws-sam/\nsamconfig.toml" >>.gitignore echo "node_modules/\n.aws-sam/\nsamconfig.toml" >>.itignore Сега сме сигурни, че всички файлове в проекта ще бъдат поставени на сцената: и след това направете първия си коммит: git add. за да добавите. git commit -m "Initial commit - AWS SAM API setup" git commit -m "Initial commit - AWS SAM API setup" Тази следваща стъпка предполага, че имате инсталиран GitHub CLI – тази стъпка е така, че да можем да създадем GitHub репо от нашия текущ директория: click to create aws-sam-cli-tutorial --public --source=. --remote=origin aws-sam-cli-tutorial - public --source=. - remote=origin Ако нямате GitHub CLI, можете да създадете репото ръчно в GitHub и след това да насочите директорията към репото си с тази команда: Git отдалечено добавяне произход https://github.com/YOUR_USERNAME/YOUR_REPO_NAME.git Git отдалечено добавяне произход https://github.com/YOUR_USERNAME/YOUR_REPO_NAME.git Накрая, нека натиснем нашия код в GitHub git push -u origin master git push -u origin master Задаване на действия на GitHub за CI/CD Нека създадем работния поток на GitHub действия файл: mkdir -p.github/workflows mkdir -p.github/workflows докоснете.github/workflows/deploy.yml touch.github/workflows/deploy.yml Заглавие на кода Отворете този файл в vscode и поставете следната конфигурация на yaml: deploy.yml .yml наименование: Деплей API към AWS CloudFormation на: push: клонове: - master jobs: deploy: runs-on: ubuntu-latest steps: - name: Checkout Code uses: actions/checkout@v3 - name: Install AWS SAM CLI uses: aws-actions/setup-sam@v2 - name: Configure AWS CLI uses: aws-actions/configure-aws-credentials@v2 with: aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }} aws-secret-access-key: ${ secrets.AWS_SECRET_ACCESS_KEY }} aws-region: us- наименование: Деплей API в AWS CloudFormation на: push: клонове: - master jobs: deploy: runs-on: ubuntu-latest steps: - name: Checkout Code uses: actions/checkout@v3 - name: Install AWS SAM CLI uses: aws-actions/setup-sam@v2 - name: Configure AWS CLI uses: aws-actions/configure-aws-credentials@v2 with: aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }} aws-secret-access-key: ${ secrets.AWS_SECRET_ACCESS_KEY }} aws-region: us-east-1 Кодът В този.yaml файл за автоматизирано внедряване, ние разчитаме на хранилищата AWS-Actions от GitHub: за да инсталираме SAM CLI и да конфигурираме нашите поверителни данни - тези AWS хранилища могат да се променят след няколко години, така че актуализирайте при необходимост. https://github.com/orgs/aws-actions/repositories https://github.com/orgs/aws-actions/repositories Сега, нека отидем на github.com - отидете на вашите хранилища, кликнете върху хранилището, което сме създали за този проект, отидете на настройки, действия и ще видите този екран, за да добавите тайни за околната среда и хранилището. Ние ще искаме да добавим тайни на хранилището за: Ние ще искаме да добавим тайни на хранилището за: AWS_ACCESS_KEY_ID AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_SECRET_ACCESS_KEY AWS_REGION Заглавие на документа AWS_REGION AWS_S3_BUCKET AWS_S3_BUCKET За да получите тези стойности, отидете на вашата AWS конзола. За ще искате да използвате същия регион, който сте разгърнали от вашата локална машина.Ако не сте сигурни за региона, потърсете cloudformation и намерете стека, който сте създали, кликнете върху него и трябва да видите региона в URL адреса. AWS_REGION, АУС_РЕГИОН, За търсете S3 в AWS конзолата и изберете кутията, която е създадена, когато сме разгърнали от нашата машина в Стъпка 4. AWS_S3_BUCKET, AWS_S3_BUCKET, For the and go to the IAM service in the AWS console: AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY, AWS_ACCESS_KEY_ID Начин на използване Съобщение за актуализация AWS_SECRET_ACCESS_KEY, От тук създайте IAM потребител, ако вече нямате такъв с достъп, който искате да използвате, и добавете поне тези области на разрешение към потребителя: AWSLambdaFullAccess IAMFullAccess AmazonS3FullAccess CloudFormationFullAccess AmazonAPIGatewayAdministrator AWSLambdaFullAccess IAMFullAccess AmazonS3FullAccess CloudFormationFullAccess AmazonAPIGatewayАдминистратор Можете също така просто да добавите , ако се чувствате комфортно с това. След това ще искаме да създадем ключ за достъп и тайна за този потребител. Изберете CLI като случай на употреба за ключа за достъп. Уверете се, че копирате тайната си, защото няма да можете да я видите отново. AdministratorAccess АдминистраторДостъп Сега се върнете в GitHub и добавете тайните на хранилището си: Добре, последната стъпка е да тествате, че всичко работи!Актуализирайте вашия app.js, за да кажете нещо друго; Промених моето на "Какво, свят!" exports.lambdaHandler = async (event) => { return { statusCode: 200, body: JSON.stringify({ message: "What up, World!" }), }; }; exports.lambdaHandler = async (event) => { return { statusCode: 200, body: JSON.stringify({ message: "What up, World!" }), }; }; След това натиснете промените в основното си клонче. - уверете се, че сте на основното клонче, когато натиснете. git add. git commit -m 'updated message' git push за да добавите. git commit -m 'updated message' Git Push Натиснете В GitHub репо трябва да видите изпълнението на действието и успешно да го разгърнете: Накрая, отидете обратно в уеб браузъра си и поставете URL адреса от API Gateway, който сме създали. Моят е: и потвърдете, че съобщението е променено. https://tt40c6vgm3.execute-api.us-east-1.amazonaws.com/Prod https://tt40c6vgm3.execute-api.us-east-1.amazonaws.com/Prod Заключение Поздравления! Вие току-що създадохте тръбопровод за внедряване на CI/CD за AWS Stack без сървър; сега можете да се заемете с изграждането на вашия API с полезни услуги.