前提条件: SAM CLIをインストールする

チュートリアルに潜入する前に、AWS SAM CLI がマシンにインストールされていることを確認してください。

for macOS

Install Homebrew (すでにインストールされていない場合):

/bin/bash -c 「$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

AWS タップを追加して SAM CLI をインストールする:

brew tap aws/tapbrew install aws-sam-cli

sam --version

For Windows

SAM CLIインストーラーをダウンロード:

• official AWS SAM CLI page にアクセスして、最新の Windows インストーラをダウンロードします。
• Go to official AWS SAM CLI page and download the latest Windows installer.
official AWS SAM CLI page




インストーラを実行する:

Run the installer をインストールする
• Double-click the downloaded .exe file and follow the installation wizard.
• Double-click the downloaded .exe file and follow the installation wizard. ダウンロードした .exe ファイルをダブルクリックし、インストールウィザードに従ってください。<コード>.exe

  
  

  SAM CLIをPATHに追加する (自動的に追加されていない場合):

  SAM CLIをPATHに追加
  • スタートメニューを開いて「環境変数」を検索します。
  • 「システム環境変数を編集する」をクリックします。
  • 「システム属性」の下で「環境変数」ボタンをクリックします。
  • 「システム変数」の下で Pathを検索し、「Edit」をクリックします。
  • 「SAM CLI」がインストールされたディレクトリを追加します(例: C:\Program Files\Amazon\AWS SAM CLI\bin)。
  • スタートメニューを開き、「環境変数」を検索します。
  • 「システム環境変数を編集する」をクリックします。
  • Under “System Properties,” click the “Environment Variables” button.
  • In “System Variables,” find Path and click “Edit.”
  <コード>Path
  • SAM CLIがインストールされたディレクトリを追加します(例: 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

    Create a new repository on your machine:mkdir aws-serverless-api コード

    
    

    ディレクトリにナビゲート: cd aws-serverless-api

    Navigate to the directory:cd aws-serverless-api

    
    

    新しいSAMアプリケーションを開始する: sam initその後、いくつかのオプションを提示されます。新しい SAM アプリケーションを初期化する:sam init

    • Choose “1 — AWS Quick Start Templates.”
    • Choose “7 — Serverless API” to deploy a Lambda-backed serverless API on API Gateway.”
    • Choose “Node.js 20.x”
    • Choose “1 — AWS Quick Start Templates.”
    “1 — AWS Quick Start Templates.”「1 — AWS Quick Start Templates」
    • Choose “7 — Serverless API” to deploy a Lambda-backed serverless API on API Gateway.”
    「7 — Serverless API」「7 — Serverless API」
    • Choose 「Node.js 20.x」
    「Node.js 20.x」「Node.js 20.x」
    • Choose "N" or No for X-Ray tracking because we want to reduce our costs, and this is just a simple Hello World example. If you are making a complex API pulling in different services, you might want to enable that to help in debugging.
    「N」「N」
    • I’m also choosing “N” for cloudwatch monitoring since we don’t need performance analytics for this Hello World example.
    • 私たちはこのHello World例のためにパフォーマンス分析を必要としません。“N”「N」
    • Also “N” for the json format in the lambda log since this is just a Hello World example.
    「N」「N」

    
    

    Now, let's cd into the directory that the sam init generated; I chose to name my project sam-hello-world so let's go:

    sam init sam-hello-world コード

    cd ハローワールド

    cd ハローワールド

    
    

    その後、VSCode code でプロジェクトを開きます. - プロジェクトを VSCode またはお気に入りの IDE で開くと、すでに多くの生成されたファイルが表示されます。code .

    生成されたファイルの理解

    Here is what each of the files generated from sam init does:

    sam init
    • **template.yaml** – API Gateway、Lambda、およびその他の AWS リソースを定義します。
    • **src/handlers/** – サンプル Lambda 関数トレーダーを含んでいます。
    • **package.json** – Node.js Lambda 関数の依存性を管理します。
    • **template.yaml** – Defines your API Gateway, Lambda, and other AWS resources.
    トップ > トップ > トップ > トップ > トップ >
    • **src/handlers/** – サンプル Lambda 関数 トレーダーを含む。
    • **events/** - 現地テストのためのサンプルテストイベント。<コード><イベント><コード>
    • **package.json** - Node.js Lambda 関数の依存性を管理します。<コード>**package.json**
    トップ > トップ > トップ > トップ > トップ > トップ > トップ > トップ > トップ > トップ > トップ > トップ > トップ > トップ > トップ > トップ ><コード><コード><コード><強く><強く>

    
    

    We will modify and remove some of these files to fit our very simple “hello world” API.

    を修正し、これらのファイルのいくつかを削除して、非常に単純な「ハローワールド」APIに適合します。

    ステップ2:APIエンドポイントを定義する

    Now, open template.yaml and replace the existing Lambda function definitions with the following:

    <コード>template.yaml

    
    

    AWSTemplateFormatVersion: "2010-09-09" Transform: AWS::Serverless-2016-10-31 Description: AWS SAM template for deploying Node.js/Express API to Lambda Resources: 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 Description: AWS SAM template for deploying Node.js/Express API to Lambda Resources: HelloWorldFunction: Type: AWS::Serverless::Function Properties: Handler: src/app.lambdaHandler Runtime: nodejs20.x Events: HelloWorld: Type: Api Properties: Path: / Method: GET

    
    

    This defines one route at the root of our API that is a GET request

    これは、GETリクエストであるAPIのルートの1つを定義します。

    Lambda 関数を更新する

    In the /src directory, let’s create a file called app.js

    /src <コード>app.js

    
    

    In src/app.js, let's write a function to output hello world from our route:

    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!" }) };

    不要なファイルを削除

    Now, let's remove the additional handlers and events that the sam init generated in step 1.

    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 イベント/

    Step 3: Build and Test Locally

    プロジェクトディレクトリで端末を開いて、以下の手順に従ってください:

    
    

    1. アプリケーションを構築する:

    アプリケーションを構築する:

    Build the application アプリケーションを作成する

    sam build you should see an output like this:

    <コード>sam build

    • 
    
    1. ローカルAPIサーバを起動する:
    • ローカルAPIサーバを起動する:
    Start a local API serverdockerが本地で実行するには docker をインストールする必要があります。

    
    

    2. ブラウザを開くか、端末で curl を使用してエンドポイントをテストしてください:

    • curl [http://127.0.0.1:3000/](http://127.0.0.1:3000/]

  • 
    

    docker をインストールして本地で実行する必要があります。 成功した場合は、ドッカーデスクトップで私たちのAPIのために作成されたコンテナを見る必要があります。

    
    

    2. ブラウザを開くか、端末で curl を使用してエンドポイントをテストしてください:

  sam local start-api — Note you’ll need to have docker installed to run this locally. When successful, you should see a container created for our API in the docker desktop.

  sam local start-api ドッカー

  
  

  2. Open a browser or use curl in the terminal to test the endpoint:
  • Open a browser or use curl in the terminal to test the endpoint:
  <コード>curl

  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を展開する

SAM を使用して API をパッケージ化し、展開する: API がローカルで動作していることを確認した後、

を使用して AWS に展開しましょう。Package and deploy the API using SAM を用いてパッケージ化し、APIを展開する

sam デプロイ --guided

sam deploy --guided




このガイド・デプロイは、以下のことを可能にします:

This guided deployment will allow you to: このガイド・デプロイは、以下のようになります。

1 ステック名を選択し、私の名前は sam-hello-world

sam-hello-world コード

2. AWS リージョンを選択します; わたしは us-east-1

u-east-1

3. 展開前に変更を確認し、 Y

を選択しました。<コード>Y <コード>

4. SAM-CLI Role Creation を許可する Y

<コード>Y <コード>

5. Rollback を無効にし、 N を選択します. we want the tool to clean up any failed resources

<コード>N

6. HelloWorldFunction には認証がありません; これは大丈夫ですか? このチュートリアルの目的のために Y

<コード>Y <コード>

7 を設定ファイルに保存する Y

<コード>Y <コード>

8 設定ファイル samconfig.toml

<コード>samconfig.toml

9. SAM 構成環境 — leave this as default




デプロイが成功した場合は、成功して作成されたリソースが次のようになります:





デプロイが成功した場合、AWSアカウントにログインし、APIゲートウェイサービスを検索してください。API設定へ行き、ドメインをブラウザウィンドウのURL入力にコピーし、URLの末尾に `/Prod` を追加して、デプロイされたAPIエンドポイントに到達してください。

あなたのAWSアカウントにログインする











My URL looks like this:














AWS コンソールで Lambda を検索して、このエンドポイントのために書いたコードが存在するデプロイされたサーバーレス Lambda 機能を表示することもできます。











S3 バケットも作成され、コードのバンドルを保有しているはずです。今、私たちは API を成功に展開したので、このプロセスを GitHub で自動化して、私たちが API で開発したいときに、Distribution は MAIN または MASTER ブランクに専念することで自動的に起動することができます。

ステップ 5: CI/CD with Github Actions

Initialize Your Git Repo and Push to Your Master Branch




最初に、私たちは git init でプロジェクトのディレクトリの git リポジトリを初期化し、それからこれらのファイルを .gitignore に追加します。<コード>git init

<コード>.gitignore




echo "node_modules/\n.aws-sam/\nsamconfig.toml" >>.gitignore

echo "node_modules/\n.aws-sam/\nsamconfig.toml" >>.gitignore




Now, we are safe to stage all of the files in the project: git add. and then make our first commit:

プロジェクトのすべてのファイルをステージにします。<コード>git add.

git commit -m "Initial commit - AWS SAM API setup"

git commit -m "Initial commit - AWS SAM API setup"




この次のステップでは、GitHub CLI がインストールされていると仮定します - このステップは、現在のディレクトリから GitHub レポを作成することができます。

gh repo create aws-sam-cli-tutorial --public --source=. --remote=origin

gh repo create 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

Set Up GitHub Actions for CI/CD

GitHubのアクションワークフローファイルを作成しましょう:




github/workflows

mkdir -p.github/workflows

touch.github/workflows/deploy.yml

touch.github/workflows/deploy.yml




Open that deploy.yml file in vscode and paste the following yaml configuration:

<コード>deploy.yml




<前>名前: AWS Cloud API にデプロイAWS CloudFormation on: push: branch: - 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名前: AWS Cloudに API をデプロイするAWS CloudFormation on: push: branch: - 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_ACC_KEY }} aws-region: us-east-1




この.yaml ファイルでは、GitHub からの AWS-Actions リポジトリに依存します: https://github.com/orgs/aws-actions/repositories SAM CLI をインストールし、当社の認証を構成します。https://github.com/orgs/aws-actions/repositories




Now, let's go to github.com — go to your repositories, click the repository we made for this project, go to settings, actions, and you'll see this screen to add environment and repository secrets.

このプロジェクトのために作成したリポジトリをクリックし、設定、アクションに移動し、環境とリポジトリの秘密を追加するためにこの画面を見るでしょう。











We will want to add Repository secrets for:

We will want to add Repository secrets for:

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 コンソールにアクセスしてください。 AWS_REGION の場合、 は、ローカルマシンから展開した同じリージョンを使用する必要があります。AWS_REGION、











For the AWS_S3_BUCKET, search for S3 in the AWS console and select the bucket that was created when we deployed from our machine in Step 4. Use the ID of this bucket for your value; mine is shown in the screenshot below.

AWS_S3_BUCKET for the AWS_S3_BUCKET, search for S3 in the AWS console and select the bucket that was created when we deployed from our machine in Step 4. Use the ID of this bucket for your value; mine is shown in the screenshot below.




AWS_S3_BUCKET、











for the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY, go to the IAM service in the AWS console:

<コード>AWS_ACCESS_KEY_IDAWS_SECRET_ACCESS_KEY、











ここから、使用したいアクセスを既に持っていない場合に IAM ユーザを作成し、少なくとも次の許可範囲をユーザに追加します。

AWSLambdaFullAccess IAMFullAccess AmazonS3FullAccess CloudFormationFullAccess AmazonAPIGateway管理者

AWSLambdaFullAccessIAMFullAccess アマゾンS3FullAccess<コード>CloudFormationFullAccessAmazonAPIGateway管理者




AdministratorAccess AdministratorAccess を追加することもできます。その後、このユーザーのためのAccessキーとSecretを作成したいと思います。Access Keyの使用例としてCLIを選択してください。Secretをコピーするようにしてください。管理者アクセス




Now, go back to GitHub and add your repository secrets:











Okay, the final step is to test that everything works! Update your app.js to say something else; I changed mine to “What up, World!”




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!" }), };




Then, push your changes to your master branch. git add . git commit -m 'updated message' git push — make sure you're on the master branch when you push.

<コード>git add.git commit -m 'updated message'git push コード




In your GitHub repo, you should see the action run and successfully deploy:











最後に、あなたのウェブブラウザに戻って、私たちが設定したAPIゲートウェイからのURLを入力します。 私の名前は: https://tt40c6vgm3.execute-api.us-east-1.amazonaws.com/Prod - メッセージが変更されたことを確認します。https://tt40c6vgm3.execute-api.us-east-1.amazonaws.com/Prod








結論

おめでとうございます! サーバーレス AWS Stack 用の CI/CD デプロイパイプラインを作成しましたが、今では、有用なサービスで API を構築することに忙しくなります。