On pojednostavljuje upravljanje infrastrukturom, pruža ugrađenu podršku za SSL/TLS i besprijekorno se integrira s AWS uslugama kao što su CloudFormation, Lambda, S3, Route 53 i CloudWatch. Korištenjem modela bez poslužitelja, programeri se mogu usredotočiti na pisanje aplikacijske logike, dok se AWS bavi skaliranjem, sigurnošću i održavanjem, što ga čini idealnim rješenjem za moderne, visoko dostupne API-je. Tabela sadržaja – Uvod: Zašto koristiti SAM za ugradnju API-ja? – Preduvjeti: Instalirajte SAM CLI – Korak 1: Inicijalizirajte SAM – Korak 2: Definiranje API Endpointa – Korak 3: Izgradite i testirajte lokalno – Korak 4: Ugradite API – Korak 5: CI / CD s Github akcijama  – Zaključak Uvod: Zašto koristiti SAM za razmještanje API-ja? Primjena API-ja pomoću AWS Serverless Application Modela (SAM) učinkovit je i skalabilan pristup za aplikacije u oblaku. Ovaj vodič će vas voditi korak po korak kako stvoriti jednostavan API, distribuirati ga pomoću AWS CloudFormation s SAM CLI-jem, a zatim automatizirati implementacije pomoću GitHub Actions. Ovdje je detaljniji diagram ovog postupka rada: Predviđeni uvjeti Predviđeni uvjeti        za lokalno testiranje.    AWS CLI i SAM CLI instalirani.   Node.js instalirani Docker  račun. GitHub AWS CLI i SAM CLI instalirani. Node.js instaliran Node.js instaliran  za lokalno testiranje. Docker Docker  račun. GitHub GitHub Preduvjeti: Instalirajte SAM CLI Prije nego što uđete u vodič, provjerite je li AWS SAM CLI instaliran na vašem računalu. Za macOS  (ako nije već instaliran): Install Homebrew Ugradite 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)" : Dodajte AWS tipku i instalirajte SAM CLI Dodajte AWS tipku i instalirajte SAM CLI brutalno otkucajte aws/tapbrew instal aws-sam-cli brisanje brisanja brisanje brisanje brisanje brisanje brisanje brisanje brisanje Provjerite instalaciju pomoću  sam --version sam - verzija Za Windows : Slobodno preuzmite program za instaliranje SAM CLI Preuzmite SAM CLI instalator     Idite na   i preuzmite najnoviji Windows installer. official AWS SAM CLI page Idite na   i preuzmite najnoviji Windows installer. official AWS SAM CLI page official AWS SAM CLI page : Ustvarite instalacijski program Upravljajte instalacijskim programom     Dvostruko kliknite preuzetu datoteku   i slijedite čarobnjak za instalaciju. .exe Dvostruko kliknite na preuzetu datoteku   i slijedite čarobnjak za instalaciju. .exe .exe i   Sljedeći članak  (ako nije automatski dodan): Dodaj SAM CLI u PUT Dodaj SAM CLI u PUT             Otvori Start izbornik i potraži "Promjene okoliša". Kliknite na "Uredi promjene okoliša sustava." U okviru "Sustavnih svojstava", kliknite na gumb "Promjene okoliša". U okviru "Promjene sustava", pronađite   i kliknite na "Edit." Path Dodajte adresar na kojem je instaliran SAM CLI (npr.  ). C:\Program Files\Amazon\AWS SAM CLI\bin Otvorite Start izbornik i potražite "Environment Variables." Kliknite na "Uredi varijable okruženja sustava." U okviru „Sustavne svojstva” kliknite na gumb „Razmjene okoliša”. U "Sustavne varijable", pronađite   i kliknite na "Uredi." Path Put i put Dodajte adresar na kojem je instaliran SAM CLI (npr.  ). C:\Program Files\Amazon\AWS SAM CLI\bin C:\Program Files\Amazon\AWS SAM CLI\bin : Otvorite uputnicu i pokrenite   Provjerite instalaciju sam --version  Provjerite instalaciju sam - verzija Korak 1: Inicijalizirajte SAM CLI   Stvorite novi repozitorij na vašem računalu: mkdir aws-serverless-api Stvorite novi repozitorij na vašem računalu: samozbornik aws-serverless-api   Navigacija na adresar: cd aws-serverless-api Navigacija na adresar: cd aws-serverless-api   tada ćete biti pozvani s nekoliko opcija. Inicijalizirajte novu SAM aplikaciju: sam init Inicijalizirajte novu SAM aplikaciju:  sam init    Izaberite        “1 – AWS Quick Start Šablone.” Izaberite   kako bismo implementirali Lambda-backed serverless API na API Gatewayu.” “7 – Serverless API” Izaberite  “Node.js 20.x” Izaberite   ili Ne za X-Ray tracking jer želimo smanjiti naše troškove, a to je samo jednostavan primjer Hello World. Ako napravite složenu API-ju koja povlači u različitim uslugama, možda želite omogućiti da pomogne pri debug “N” Odaberite  “1 — AWS Quick Start Predlošci.” “1 — AWS Quick Start Predlošci.” “1 — AWS Quick Start Predlošci.” Odaberite   kako biste implementirali Lambda-backed serverless API na API Gateway.” “7 — Serverless API” “7 – API bez poslužitelja”  „7 — Serverless API” Odaberite  ”Node.js 20.x” „Node.js 20.x”  „Node.js 20.x” Odaberite   ili Ne za praćenje X-Ray jer želimo smanjiti naše troškove, a ovo je samo jednostavan primjer Hello World. "N" “N”  „N“ Ja također biram   za praćenje cloudwatch jer nam nije potrebna analiza performansi za ovaj primjer Hello World. “N” “N”  „N“ Also   for the json format in the lambda log since this is just a Hello World example. “N” “N”  „N“ Sada, hajdemo cd u direktorij koji je generirao  ; Odlučio sam nazvati svoj projekt   pa hajdemo: sam init sam-hello-world  sam init   Sljedeći članak sam-hello-svijet cd sam-hello-world CD sam-hello-world Tada otvorite projekt u VSCode   - kada otvorite projekt u VSCode ili vaš omiljeni IDE, već biste trebali vidjeti puno generiranih datoteka. code.  kod. Razumijevanje generiranih datoteka Ovdje je što svaka od datoteka generiranih iz   čini: sam init  sam init             – definira vaše API Gateway, Lambda i druge AWS resurse. **template.yaml**  – sadrži primjerke upravljača funkcijama Lambda. **src/handlers/**  – primjerke test događaja za lokalno testiranje. **events/**  – upravlja ovisnostima za Node.js Lambda funkcije. **package.json**   .gitignore**  – Standardne datoteke za postavljanje projekta.    – definira vaš API Gateway, Lambda i druge AWS resurse. **template.yaml** **template.yaml**  – sadrži uzorak upravljača funkcijama Lambda. **src/handlers/** **src/handlers/**  – Uzorci testnih događaja za lokalno testiranje. **events/**  ** događanja/**  – upravlja ovisnostima za Node.js Lambda funkcije. **package.json** **package.json** **.mjesečnica**    – Standardne datoteke za postavljanje projekta. **README.md**        i  **README.md** Mi ćemo  .  izmijeniti i ukloniti neke od tih datoteka kako bi se uklopili u naš vrlo jednostavan "hello world" API modify i ukloniti neke od tih datoteka kako bi se uklopili u naš vrlo jednostavan "hello world" API Korak 2: Definiranje API Endpointa Sada otvorite   i zamijenite postojeće definicije funkcija Lambda sljedećim: template.yaml template.yaml i  AWSTemplateFormatVersion: "2010-09-09" Transform: AWS::Serverless-2016-10-31 Opis: AWS SAM predložak za razmjenu Node.js/Express API na Lambda resurse: HelloWorldFunction: Tip: AWS::Serverless::Function Properties: Handler: src/app.lambdaHandler Runtime: nodejs20.x Događanja: HelloWorld: Tip: Api Properties: Path: / Metoda: GET  AWSTemplateFormatVersion: "2010-09-09" Transform: AWS::Serverless-2016-10-31 Opis: AWS SAM predložak za razmjenu Node.js/Express API na Lambda resurse: HelloWorldFunction: Tip: AWS::Serverless::Function Properties: Handler: src/app.lambdaHandler Runtime: nodejs20.x Događanja: HelloWorld: Tip: Api Properties: Path: / Metoda: GET  Ovo definira jednu rutu na korijenu našeg API-ja koja je GET zahtjev Aktualizirajte Lambda funkciju U imeniku   kreirajte datoteku nazvanu  /src app.js  / src  app.js i  U  , napišimo funkciju za izlazak hello world iz naše rute: src/app.js src/app.js i   mora biti instaliran za pokretanje ovog lokalno. Kada uspijete, trebali biste vidjeti kontejner stvoren za naš API u docker desktop.      exports.lambdaHandler = async (event) => { vratiti { statusCode: 200, tijelo: JSON.stringify({ poruka: "Hello, World!" }) }; };  exports.lambdaHandler = async (event) => { vratiti { statusCode: 200, tijelo: JSON.stringify({ poruka: "Hello, World!" }) }; };  Ukloniti nepotrebne datoteke Now, let’s remove the additional handlers and events that the   generated in step 1. sam init sam init Otvorite terminal u projektnom direktoriju i  : izvršite ove komande izvršite ove zapovijedi 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 events/ rm -rf događaji/ Korak 3: Izgradite i testirajte lokalno Otvorite terminal u projektnom direktoriju i slijedite sljedeće korake:     : Izgradite aplikaciju : Uredi aplikaciju Izgradite aplikaciju        trebali biste vidjeti izlaz kao ovaj: sam build  trebali biste vidjeti izlaz kao ovaj: sam build sam graditi     : Start lokalnog API poslužitelja : Start lokalnog API poslužitelja Start lokalnog API poslužitelja docker   Otvorite preglednik ili koristite   u terminalu da biste testirali krajnju točku:  curl   curl [http://127.0.0.1:3000/] (http://127.0.0.1:3000/]            docker instaliran da biste ga pokrenuli lokalno. Kada uspijete, trebali biste vidjeti kontejner stvoren za naš API u docker desktopu.     Otvorite preglednik ili koristite   u terminalu da biste testirali krajnju točku: curl  — Imajte na umu da ćete morati imati   instaliran da biste to pokrenuli lokalno. sam lokalno start-api docker sam lokalno start-api docker     Otvorite preglednik ili koristite   u terminalu kako biste testirali krajnju točku: curl Otvorite preglednik ili koristite   u terminalu kako biste testirali krajnju točku: curl Curl   u nastavku     curl [http://127.0.0.1:3000/](http://127.0.0.1:3000/) Curl [http://127.0.0.1:3000/](http://127.0.0.0.1:3000/) Curl [http://127.0.0.1:3000/](http://127.0.0.0.1:3000/)     Ako vidite JSON vraćen iz naše krajnje točke, onda ste uspješno pokrenuli API lokalno!  Korak 4: Ugradnja API-ja : Sada kada smo potvrdili da naš API radi lokalno, hajde da ga implementiramo na AWS pomoću Pakirajte i implementirajte API pomoću SAM Pakiranje i ugradnja API-ja pomoću SAM sam implementacija --guided sam ugraditi --guided Ova vodena implementacija će vam omogućiti: Ovo vodeno raspoređivanje omogućit će vam: 1. Odaberite ime stacka; moj je  sam-hello-world sam-hello-svijet 2. Choose AWS Region; mine is  us-east-1 sjeverna Koreja 3. Potvrdite promjene prije implementacije; odabrao sam  Y  i  4. Omogućiti SAM-CLI kreiranje uloga,  Y  i  5. onemogućite Rollback, odaberite   želimo alat za čišćenje neuspjelih resursa N N  6. HelloWorldFunction nema autentifikaciju; je li to u redu? Za potrebe ovog tutorial  Y  i  Zaštitite argumente u konfiguracijsku datoteku  Y  i   Sljedeći članakKonfiguracijsko okruženje SAM – ostavite ovo kao podrazumijevanje  u nastavku 8. Konfiguracijska datoteka  samconfig.toml samconfig.toml Ako je vaša implementacija bila uspješna, vi biste trebali vidjeti resurse koji su uspješno stvoreni ovako: Kada je implementacija uspješna,   i potražite uslugu API Gateway. Idite na postavke API-ja, kopirajte svoj domen u ulaznu adresu URL-a na prozoru preglednika i dodajte `/Prod` na kraj svog URL-a kako biste stigli do svoje raspoređene API krajnje točke. Prijavite se na svoj AWS račun log in to your AWS account Moj URL izgleda ovako: Također možete pretraživati Lambdu u AWS konzoli kako biste vidjeli svoju raspoređenu Lambdu bez poslužitelja, gdje kod koji smo napisali za ovu krajnju točku živi. Također biste trebali vidjeti S3 bucket stvoren, koji drži paket našeg koda.Sada kada smo uspješno implementirali naš API, automatizirajmo ovaj proces s GitHubom tako da kad god želimo razvijati na našem API-ju, implementiranje može automatski pokrenuti samo obvezujući se na MAIN ili MASTER granu. Korak 5: CI/CD s Github akcijama Inicijalizirajte svoj Git Repo i gurnite u svoju glavnu granu Prvo, inicijalizirat ćemo git repozitorij u adresaru našeg projekta s  Zatim, dodajmo te datoteke u naš   jer ih ne želimo preuzeti. git init .gitignore Git init .navodnja echo "node_modules/\n.aws-sam/\nsamconfig.toml" >>.gitignore echo "node_modules/\n.aws-sam/\nsamconfig.toml" >>.gitignore Sada smo sigurni da ćemo podići sve datoteke u projektu:   i onda napraviti naš prvi komite: git add. Primjenjuje se. git commit -m "Initial commit - AWS SAM API setup" git commit -m "Initial commit - AWS SAM API setup" Ovaj sljedeći korak pretpostavlja da imate instaliran GitHub CLI - Ovaj korak je kako bismo mogli stvoriti GitHub repo iz našeg trenutnog adresara: kako stvoriti aws-sam-cli-tutorial --public --source=. --remote=origin e-mail create aws-sam-cli-tutorial --public --source=. --remote=origin If you don’t have the GitHub CLI, you can create the repo manually on GitHub and then point the directory to your repo with this command: git daljinski dodaj izvor https://github.com/YOUR_USERNAME/YOUR_REPO_NAME.git Git daljinski dodaj izvor https://github.com/YOUR_USERNAME/YOUR_REPO_NAME.git Konačno, hajde da guramo naš kod na GitHub  git push -u origin master git push -u origin master Postavljanje GitHub akcija za CI/CD Učinimo GitHub akcije workflow datoteku: mkdir -p .github/workflows mcdir -p.github/workflows touch.github/workflows/deploy.yml touch.github/workflows/deploy.yml Otvori tu   datoteku u vscode i prilepi sljedeću konfiguraciju yaml: deploy.yml slijedeći članak.yml ime: Deploy API to AWS CloudFormation on: push: branches: - 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 - name ime: Rasporedite API na AWS CloudFormation na: push: granične: - master jobs: rasporedite: runs-on: ubuntu-latest koraka: - ime: Checkout Code koristi: akcije/checkout@v3 - ime: Instalirajte AWS SAM CLI koristi: aws-actions/setup-sam@v2 - ime: Configure AWS CLI koristi: aws-actions/configure-aws-credentials@v2 s: aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }} aws-seccess-key: ${ secrets.AWS_SECRET_ACCESS_KEY }} aws-region: us-east-1  Sljedeći članak  Sljedeći članak  u nastavku In this .yaml file for automated deployment, we rely on the AWS-Actions repositories from GitHub:   to install the SAM CLI and configure our credentials — these AWS repos may change in a few years, so update as needed. https://github.com/orgs/aws-actions/repositories https://github.com/orgs/aws-actions/repositories Sada, idemo na github.com - idite na svoje repozitorije, kliknite na repozitorij koji smo napravili za ovaj projekt, idite na postavke, akcije, a vidjet ćete ovaj zaslon za dodavanje okruženja i tajni repozitorija. Željet ćemo dodati tajne skladišta za: Željet ćemo dodati tajne skladišta za: 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 Da biste dobili ove vrijednosti, idite na AWS konzolu. Za   želite koristiti istu regiju koju ste raspoređivali s lokalnog računala. Ako niste sigurni za regiju, potražite cloudformation i pronađite skup koji ste stvorili, kliknite na nju i trebate vidjeti regiju u URL-u. AWS_REGION, AWS_REGION, Za   potražite S3 u AWS konzoli i odaberite bucket koji je stvoren kada smo ga razmjestili s našeg stroja u Koraku 4. AWS_S3_BUCKET, AWS_S3_BUCKET, Za   i   idite na IAM uslugu u AWS konzoli: AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY, AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY, Ovdje kreirajte korisnika IAM-a ako ga već nemate s pristupom koji želite koristiti i dodajte barem sljedeće opsege dozvola korisniku:       AWSLambdaFullAccess IAMFullAccess AmazonS3FullAccess CloudFormationFullAccess AmazonAPIGatewayAdministrator AWSLambdaFullAccess IAMFullAccess AmazonS3FullAccess Sljedeći članakFullAccess AmazonAPIGatewayUpravitelj Također možete jednostavno dodati   ako vam je to ugodno. Nakon toga, želimo stvoriti pristupni ključ i tajnu za tog korisnika. Odaberite CLI kao slučaj korištenja za pristupni ključ. AdministratorAccess AdministratorPristup Sada se vratite na GitHub i dodajte svoje tajne repozitorija: U redu, posljednji korak je testiranje da sve funkcionira! ažurirajte svoj app.js kako biste rekli nešto drugo; promijenio sam svoj na "Što, svijet!" exports.lambdaHandler = async (event) => { return { statusCode: 200, body: JSON.stringify({ message: "What up, World!" }), }; };  exports.lambdaHandler = async (event) => { vratiti { statusCode: 200, tijelo: JSON.stringify({ poruka: "Što se događa, svijet!" }), }; };  Tada pritisnite promjene na svoju glavnu granu.       - pobrinite se da ste na glavnoj grani kada pritisnete. git dodati. git commit -m 'updated message' git push git add . git commit -m 'aktualizirana poruka' Git Push U vašem GitHub repo, trebali biste vidjeti akciju i uspješno implementirati: Konačno, vratite se na svoj web preglednik i prilepite URL od API-ja koji smo postavili. Moj je:   - i potvrdite da je poruka promijenjena. https://tt40c6vgm3.execute-api.us-east-1.amazonaws.com/Prod https://tt40c6vgm3.execute-api.us-east-1.amazonaws.com/Prod Završni prijedlog Čestitke! upravo ste stvorili CI/CD distribucijsku liniju za AWS Stack bez poslužitelja; sada možete biti zauzeti izgradnjom vašeg API-ja s korisnim uslugama.

Read My Stories

Ovaj zvuk je proizveden na izvornom jeziku priče!

Kako implementirati API bez poslužitelja s AWS SAM CLI & GitHub radnjama

About Author

KOMENTARI

VIJESI OZNAKE

OVAJ ČLANAK JE PREDSTAVLJEN U

Related Stories

Light-Mode

Classic

Newspaper

Dark-Mode

Neon Noir

Minty

HN StartUps