"Lambda API"と"Serverless Framework"を使ってLambda上にサーバーレスAPIを構築する

前置き

APIの構築というジャンルではAWS Lambda + AWS API GateWayという組み合わせは鉄板ではないでしょうか。メンテナンスが不要でコストが低く、サーバ運用の悩みを抱えなくて済むので気に入っています。

ですがLambdaと出会った頃の私は「Lambdaにどんなソースコードを書いたらいいのかわからない」となっていました。
そして少しの時が経ち、最近の私はAPIの処理をLambda APIで実装し、それをServerless Frameworkによって展開するのがかなりイケてるのではと思うようになりました。この記事ではこの構成について解説します。

名称がとてもわかりにくいのですが、Lambda APIもServerless Frameworkもフレームワーク名(=固有名詞)です。私は最初、仕組み(やり方)と勘違いして理解が遅くなりました。このことを念頭に読み進めていくと理解がスムーズになるかと思います。

なお、Lambda APIとServerless Frameworkは直接関係するものではありません。ですが両者を同時に導入するのが最も開発体験 (DX=DeveloperExperience) が高くなると思うので、同時に紹介することにしました。

この記事で紹介する構成

勘違いされそうな本記事の要約

• 誤: LambdaにサーバーレスなAPIを作る方法を解説
  • 完全な誤りではありませんが、やりたいことは違うんです...。

実際の本記事の要約

• 正: Lambda API(Lambda用のフレームワーク)とServerless Framework(AWSの構成管理に関するフレームワーク)によってAPIサーバを構築する方法を解説

この記事で詳しく解説しないこと

• AWSの初歩的なこと (Lambdaとは、API Gatewayとは、IAMとは、etc)
• JavaScriptやNodeのこと

Lambda API

言葉の定義

この記事で単にLambdaと記載した場合はAWS Lambda(AWSが提供するサービス)を指します。
Lambda APIと記載した場合はLambda API (フレームワーク)を指します。

なぜLambda API？

Lambdaの用途は縛られることがなく、ソースコードをかなり自由に書くことができます。これは嬉しい側面もありますが、一方でAPI構築では「どのようなソースコードが適切かを検討しないといけない」「よくあるAPI用の処理を自分で実装したくない」といった悩みが発生します。

そう、Lambda用のフレームワークが欲しくなるのです。

私はRuby on RailsやLaravelといったMVCフレームワークに慣れ親しんでいましたが、それらは要求されるアーキテクチャが異なるためLambdaで動かすことができません。ExpressやFastifyといったNode製のフレームワークなら動くのかもしれませんが、必要以上に重たい印象があります。

そんな時に導入をオススメしたいのがLambda APIです。

Lambda APIとは

プロフィール

• npmレジストリ: lambda-api - npm
• GitHub リポジトリ: jeremydaly / lambda-api
• GitHub Stars: 1.2k
• 作成開始: 2017年頃 (Gitのfirst commitから取得)
• 最終更新: 2023-03-14
• 最新バージョン: v1.0.1
• ライセンス: MIT
• 作者(メインコントリビュータ): jeremydaly (Jeremy Daly) - GitHub
• 開発言語: JavaScript

※ いずれも2023-03-30時点

LambdaAPIの簡易解説

READMEに記載されているフレームワークの趣旨をざっくり書くと「Node製のWebフレームワーク (Expressなど) は素晴らしいけれどサーバレスのLambdaには向いていていない。そのため他のパッケージに依存しない軽量なフレームワークを作成した」とのことでした。
また、ExpressやFastifyと似た構文を採用しているとのことで、それらの前提知識があればスムーズにコーディングできます。

詳細はREADMEを参照してください。

なぜ私がLambda APIをオススメするのか

Lambda上にAPIサーバを構築しようとした時、APIのコアにあたる処理は似たようなものに落ち着くので、自分で実装するのは無駄(車輪の再発明)と感じます。労力削減のためにフレームワークやライブラリに頼りたくなります。
また、Lambdaの特性やメリットを考えると、高機能なフレームワークは向かないと感じます。

こう考えていた時にLambda APIと出会いました。

欲しい機能が"必要"かつ"十分"に揃っているフレームワークを探したところ、自分が考える状態に最も近かったのがLambda APIでした。
Lambda APIは作りたいロジックの構築に注力させてくれました。構文がExpressと似ていて取り掛かりやすかったです。そして親切でシンプルなREADMEが揃っていました。

Lambda APIの採用にあたって心配な点

小さめなプロジェクトのため、長期的にメンテナンスが続いていくことに対しては少し不安があります。
ですがコード量が少なく、MITライセンスなので、いざとなったら自身でパッチを当てればよいという感覚でよいと考えています。

Lambda API以外の選択肢

同じようなフレームワークやライブラリは他にも存在します。私はLambda APIが好みでしたが、他を採用する方がいいケースもあるかもしれません。

Lambda APIとの比較検討で調べたものを名前だけ紹介します。リンク先は最もわかりやすそうなところにしました。そのため統一感はありません。

• Middy (Middyの公式ドキュメント)
• Serverless Express (GitHub)
• Fastify - Serverless (Fastify内のServerlessのドキュメント)

Serverless Frameworkとは

一旦Lambda APIのことを横に置き、続いてServerless Frameworkの紹介に移ります。

Lambda APIのことを知らなくてもServerless Frameworkのことを知っている人は多いのではないでしょうか。
ここでは表面的なことしか解説しないので、既に知っている方はこの節を読み飛ばしてください。

プロフィール

• 公式HP: Serverless
• GitHub リポジトリ: serverless / serverless
• GitHub Stars: 44.4k
• 作成開始: 2015年頃 (Gitのfirst commitから取得)
• 最終更新: 2023-03-24
• 最新バージョン: v3.29.0
• ライセンス: MIT
• 作者: Serverless, Inc.
• 開発言語: Node.js

※ いずれも2023-03-30時点

Serverless Frameworkの簡易解説

Serverless Frameworkとはサーバレス環境 (サーバを意識する必要がない環境) やその周辺環境を構成管理 (コードをデプロイしたり、リソースを管理したり) するためのフレームワークです。
Serverless FrameworkはAzureやGCPなどにも対応しているようですが、AWSで使うことが一般的です。

なぜ私がServerless Frameworkをオススメするのか

LambdaやAPI Gatewayを利用する際、様々な設定が必要となります。
これは従来のサーバ構築に比べれば楽ですが、それでも少し大変です。限りある時間をAPI本体の構築に割きたいです。
Serverless Frameworkなら設定ファイルを用意するだけでこれを実現してくれます。

Serverless Frameworkは広く利用されています。Lambdaの採用を決めた時点で迷うことなくServerless Frameworkの採用も決めるケースも多いのではないでしょうか。

なぜLambda APIと同時にserverless frameworkもオススメするのか

両者は直接関連するものではありません。
ですがLambda APIを使用した開発の際にはServerless Frameworkの導入も必須と考えています。そのため、この記事では両者を同時に解説することにしました。
ちなみにLambda APIの作者の導入解説でもServerless Frameworkを前提とした手順を紹介していました。

実際の導入手順

ここまでで解説してきたことを実際に構築してみたいと思います。

ソースコードの完成形はGitHubに上げてあります。

GitHub ljourm/sample-lambda-api-serverless
コミットごとに参照すると読みやすいかもしれません (各コミットへのリンク)

Serverless Frameworkの導入

• 対応するGitHubのコミット
  • feat: serverlessの導入
  • feat: serverlessが最低限動作するように整備

まずServerless Frameworkを導入します。
グローバルで使用可能にする記事が多いですが、私はyarnでpackage.jsonに導入する方が好きなので、こちらの書き方で進めます。

$ yarn add -D serverless

# 以下を紹介している記事が多いが、今回はyarnでpackage.jsonに追加する方法で記載
npm install -g serverless

次にLambda関数用のソースコードを作成します。この時点ではまだLambda APIは未使用です。

handler.js

exports.router = async (event, context, callback) => {
  return {
    statusCode: 200,
    headers: {},
    body: JSON.stringify({ message: "hello world" }),
  };
};

そしてServerless Frameworkの設定を追加します。初見でもなんとなく読めるのではないでしょうか。

serverles.yml

service: sample-lambda-api

provider:
  name: aws
  runtime: nodejs18.x
  region: ap-northeast-1

functions:
  hello: # 関数名をhelloにする
    handler: handler.router # handler.jsのrouterメソッドを呼び出す
    events:
      - httpApi: # API Gatewayにアクセスしてきた全てをLambdaに流す
          method: "*"
          path: "*"

ここまで作成したらデプロイコマンドを実行します。
これによってLambdaにhandler.jsがデプロイされ、さらにLambdaに繋げるためのAPI Gatewayも同時に生成されます。

$ yarn serverless deploy

API GatewayのURLにアクセスするとレスポンスの取得ができるようになります。

Lambda APIの導入

• 対応するGitHubのコミット
  • feat: lambda-apiの導入
  • feat: lambba-apiのpeerDependenciesの導入
  • feat: lambda-apiを最低限で導入

続いてLambda APIを導入します。

# lambda-apiの導入
$ yarn add lambda-api

# lambda-apiの依存パッケージの導入
$ yarn add -D @aws-sdk/client-s3 @aws-sdk/s3-request-presigner

次に先ほど作成したhandler.jsをLambda APIを使用した状態に書き換えます。
ここではLambda APIのサンプルとほとんど同じコードを書いてみます。Expressを知っている方にとっては馴染みのある文法になっていると思います。

handler.js

// 先ほどのコードは全て削除し、以下を記述

const api = require("lambda-api")();

api.get("/status", async (req, res) => {
  return { status: "ok" };
});

exports.router = async (event, context, callback) => {
  return await api.run(event, context);
};

ここまで作成したら再度デプロイコマンドを実行します。
これによって先ほどデプロイしたLambdaのhandler.jsが更新されます。ちなみにAPI Gatewayは同じなため変更されません。

$ yarn serverless deploy

再度API GatewayのURLにアクセスすると変更されたレスポンスの取得ができるようになります。

Serverless Offlineの導入

• 対応するGitHubのコミット
  • feat: serverless-offlineの導入

ここまででAWS環境にLambda APIを使用したJavaScriptをデプロイすることが可能になりました。ですが、今の段階では作成したプログラムの動作確認をローカル環境で行うことができません。
invoke localを使うと少し解決できますが、使いやすいものではない印象です。

そこでServerless FlameworkのプラグインServerless Offlineを導入して、オフライン (ローカル環境) で動作可能にします。

以下によってプラグインを導入してください。

$ yarn add -D serverless-offline

serverless.yml

plugins:
  - serverless-offline

そして以下を実行します。これによってローカル環境にサーバが立ち上がります。

$ yarn serverless offline

# Docker環境の場合、アクセス元が絞られるため--hostを追加してください
$ yarn serverless offline --host 0.0.0.0

これで localhost:3000 にアクセスすることができるようになりました。
毎回Lambdaにデプロイして動作確認するのは大変なので、このやり方はとても便利だと思います。

最後に

この記事ではLambda APIの使い方について細かく解説していませんが、READMEはサンプルも添えて記載されているので、英語が苦手な人でも読みやすい内容ではないかと思います。

Lambda APIは今のところ、それほど広く知られてはいないようです。
この記事によってLambda APIで軽量なAPIが簡単に作れることが伝わり、ユーザーが増えていくと嬉しいです。
そしてLambda APIを使う際はServerless Frameworkも同時に使ってみてください。