MS Tech camp #4 ~Azure Functions と Cosmos DB でサーバレス Web API を作ろう！~

MS Tech Camp #4 のハンズオン資料です。

このハンズオンでは、タスク管理のための Web API を Azure Functions と Azure Cosmos DB を使って作ります。具体的には、以下のエンドポイントを提供する Web API を開発します。

GET /tasks ：タスクの一覧を取得
GET /tasks/{id} ：指定した id を持つタスクを取得
POST /tasks ：リクエストボディで指定したタスクを追加

タスクの例を次に示します。

{
    "id": "1"                // タスクのID
    "task": "あれとこれをする", // タスクの内容
    "userId": "123456",      // タスク作成者のユーザID
    "duedate": "2021/02/30"  // タスクの期日
}

1. Azure Cosmos DB アカウントを作成

まず、Azure Cosmos DB のアカウントを作成するところから始めましょう。

Azure portal から リソースの作成 を選択します。
新規ページで「Azure Cosmos DB」を検索して選択します。

作成を選択します。

以下の設定値を入力して、確認と作成 を選択します。

項目	設定値	例
サブスクリプション	任意	Azure for Students
リソースグループ	新規作成で任意	mstechcamp
アカウント名	任意（一意の名前）	mstechcamp
API	コア（SQL）
場所	任意	（Asia Pacific）東日本
容量モード	プロビジョニングされたスループット
Free レベルの割引の適用	適用

※ アカウント名は世界中で一意な名前である必要があります。

※ API で設定したコア（SQL）では、SQL 構文を使用して Cosmos DB のデータベースを操作することができます。 2021年2月現在、Azure Functions と Cosmos DB を簡単に連携（バインド）するには、この SQL API を使用する必要があります。

※ 次のスクリーンショットでは Free レベルの割引の適用が無効になっていますが、無料の Cosmos DB アカウントが既に存在していなければ有効になっているはずで、無料で利用できるはずです。

アカウントの設定を確認し、作成を選択します。

デプロイが完了しました と表示されるまで数分待ちます。表示されたら リソースに移動 を選択します。これで Cosmos DB アカウントの作成は完了です！

2. Azure Cosmos DB コンテナーを作成

続いて、Cosmos DB のアカウントにデータを格納するための コンテナー を作成していきます。 Azure Functions を設定するときに自動的に作成することも可能ですが、今回のハンズオンでは手作業でやりたいと思います。

Azure Cosmos DB アカウントの概要ページに移動して、上部のメニューバーにある コンテナーの追加 を選択します。

New Container を選択して、以下の設定値を入力します。入力が終わったら OK を選択します。これでコンテナーの作成は完了です！

項目	設定値
Database id	taskDatabase
Provision database throughput	チェックを入れる
Throughput	400
Container id	taskContainer
Partition key	/userId

※ Cosmos DB の無料枠では、5GB のストレージ容量と最大 400RU/s のスループットが提供されます。

※ RU（Request Unit）はデータベースの操作にかかるコストで、1RU は 1KB のアイテムを読み取るコストに相当します。

※ 実際のアプリケーション開発の際にスループットやパーティーションキーをどのように設定するべきかは、Microsoft Learn のスケーリングするようにビルドされた Azure Cosmos DB データベースを作成するで解説されています。

作成したコンテナーの現状を確認するには、データエクスプローラー ページで taskDatabase → taskContainer → Items と選択します。現在はまだデータは格納されていません。

3. Azure Functions の関数アプリを作成

ここからは Azure Functions を設定していきます。まず、Function App（関数アプリ）を作成しましょう。

Azure portal から リソースの作成 を選択します。
新規ページで「Function App」を検索して選択します。

作成を選択します。

以下の設定値を入力して、確認および作成 を選択します。

項目	設定値	例
サブスクリプション	Cosmos DB と同じ	Azure for Students
リソースグループ	Cosmos DB と同じ	mstechcamp
関数アプリ名	任意（一意の名前）	mstechcamp-api
公開	コード
ランタイムスタック	Node.js
バージョン	14 LTS
地域	Cosmos DB と同じ	Japan East

※ 関数アプリ名は世界中で一意な名前である必要があります。

※ 関数アプリ名に azurewebsites.net を加えた名前が Web API の URL になります。

※ 今回は JavaScript を使って実装することにします。

関数アプリの設定を確認し、作成を選択します。

デプロイが完了しました と表示されるまで数分待ちます。表示されたら リソースに移動 を選択します。これで関数アプリの作成は完了です！

4. Azure Functions の関数を作成

続いて、関数アプリに関数を追加します。

今回は2つの関数を作ります。

データベースにタスクを追加するための Create 関数
データベースからタスクを読み取るための Read 関数

これから作る Web API は合計3つのエンドポイントを公開しますが、作成する関数は上記の2つのみです。これは Read 関数1つで GET /tasks と GET /tasks/{id} の2つのエンドポイントを実装することにするためです。

4.1 Create 関数を追加

まずは、Create 関数から作ります。

関数アプリの関数ページに移動して、上部のメニューバーにある追加を選択します。 関数の追加 ウィンドウが表示されます。

以下の設定値を入力して、追加を選択します。

項目	設定値
開発環境	ポータルでの開発
テンプレート	HTTP trigger
新しい関数	Create
Authorization level	Anonymous

※ Visual Studio Code などを使ってローカルで開発することも可能ですが、今回はポータル上で開発していきます。

※ HTTP trigger は HTTP リクエストをトリガーとして関数を実行します。

※ Anonymous は関数を実行するための HTTP リクエストに特殊なパラメータが要らない承認レベルです。今回は簡単のために Anonymous を使用します。

Create 関数のページに移動したら、統合を選択し、HTTP (req) を選択します。 トリガーの編集 ウィンドウが表示されます。

Selected HTTP methods の GET のチェックを外し、保存を選択します。

出力の追加 を選択します。 出力の作成 ウィンドウで、以下の設定値を入力して、OK を選択します。

項目	設定値
バインドの種類	Azure Cosmos DB
Document parameter name	taskDocument
Database name	taskDatabase
Collection Name	taskContainer
If true, creates the Cosmos DB databas...	いいえ
Cosmos DB account connection	（新規作成）

Cosmos DB account connection を新規作成する手順は次の通りです。

New を選択します。
Azure Cosmos DB アカウント を選択し、前の手順で作成したデータベースアカウント（例えば mstechcamp）を選択してから、OK を選択します。

※ 関数のコード内では、ドキュメントパラメータ名で指定した名前（ここでは taskDocument）で Cosmos DB オブジェクトを参照できます。

コードとテスト ページに移動し、既存の関数のコードを、次のコードに書き換えます。その後、保存を選択します。

module.exports = async function (context, req) {
    if (req.body.task && req.body.userId) {

        // リクエストのボディをデータベースにそのまま格納
        context.bindings.taskDocument = req.body;

        // 成功
        context.res = {
            status: 200
        };

    } else {
        // 失敗
        context.res = {
            status: 400,
            body: "The query options 'task' and 'userId' are required."
        };
    }
}

taskDocument に代入された HTTP リクエストのボディは、Azure Functions のバインディング機能によって、Cosmos DB のデータベースに格納されます。

ボディにパラメータ task と userId がない場合は、エラーとします。

以上で Create 関数の追加は完了です！

4.2 Create 関数をテスト

Create 関数の動作を確認してみましょう。

テストと実行 を選択し、入力タブの ボディ のコードを次のコードで置き換えます。

{
    "task": "あれとこれをする",
    "userId": "123456",
    "duedate": "2021/02/30"
}

実行を選択します。

実行結果の出力タブで、HTTP 応答コード が 200 OK になっていれば OK です！

ここで一度、プロキシ機能の設定に使うために、Create 関数の URL をメモしておきます。関数の URL は コードとテストページ の上部のメニューバーにある 関数の URL の取得 を選択することで取得できます。

例えば、https://mstechcamp-api.azurewebsites.net/api/Create? のような URL をメモしておきます。

それでは、Read 関数を追加して、本当にデータが追加されたかどうかを確認してみましょう。

4.3 Read 関数を追加

これまでと同様の手順で Read 関数を追加していきます。 Create 関数と異なるのは、出力バインディングではなく入力バインディングに Cosmos DB を設定するところです。

関数アプリの関数ページに移動して、上部のメニューバーにある追加を選択します。 関数の追加 ウィンドウで、以下の設定値を入力し、追加を選択します。

項目	設定値
開発環境	ポータルでの開発
テンプレート	HTTP trigger
新しい関数	Read
Authorization level	Anonymous

統合ページに移動して、HTTP (req) を選択します。 トリガーの編集 ウィンドウで、Selected HTTP methods の POST のチェックを外し、保存を選択します。

入力の追加 を選択します。 入力の作成 ウィンドウで、以下の設定値を入力して、OK を選択します。

項目	設定値
バインドの種類	Azure Cosmos DB
Document parameter name	taskDocument
Database name	taskDatabase
Collection Name	taskContainer
Cosmos DB account connection	（Create 関数と同じ）

コードとテスト ページに移動し、既存の関数のコードを、次のコードに書き換えます。その後、保存を選択します。

module.exports = async function (context, req) {
    if (req.query.id) {
        // 指定した id を持つタスクを取得
        const task = context.bindings.taskDocument
                        .find(e => e.id === req.query.id);

        if (task) {
            // 成功
            context.res = {
                status: 200,
                body: {
                    id: task.id,
                    task: task.task,
                    userId: task.userId,
                    duedate: task.duedate
                }
            };
        } else {
            // 失敗
            context.res = {
                status: 404,
                body: "Not found."
            };
        }

    } else {
        // タスクの一覧を取得
        context.res = {
            status: 200,
            body: context.bindings.taskDocument.map(e => {
                return {
                    id: e.id,
                    task: e.task,
                    userId: e.userId,
                    duedate: e.duedate
                };
            })
        };
    }
}

このコードでは、レスポンスに含める項目を取捨選択しています。これにより Cosmos DB のシステム内で使われるプロパティを返さないようにしています。

以上で Read 関数の追加は完了です！

4.4 Read 関数をテスト

まずは、一覧取得をテストしましょう。

テストと実行 を選択し、入力タブの HTTP メソッド を GET に設定します。 ボディ は必要ありませんが、今回の実装では無視されるため、そのままでも問題ありません。
実行を選択します。

実行結果の出力タブで、HTTP 応答のコンテンツ に Create 関数のテストで入力したタスクが表示されていることを確認します。

（時間があれば）id を指定する場合のテストをしましょう。

表示されている id の値（例えば 53a369ec-3171-41c7-b4c4-8a1e42c5a402）をメモしておきます。

テストと実行 を選択し、入力タブの HTTP メソッド を GET に設定します。そして、クエリ を以下のように設定します。今回も ボディ は必要ありません。

名前	値
id	（メモした id の値）

実行を選択します。
出力タブの HTTP 応答のコンテンツ に指定した id と一致するタスクが表示されていることを確認します。

もしデータベースに存在しない id を クエリ の値に入力した場合は、Not found. と表示されるはずです。

以上で2つの関数の追加とテストは完了です！

最後に、Create 関数と同様に、Read 関数の URL もメモしておきましょう。関数の URL は コードとテストページ の上部のメニューバーにある 関数の URL の取得 を選択することで取得できます。

例えば、https://mstechcamp-api.azurewebsites.net/api/Read? のような URL をメモしておきます。

この URL にブラウザでアクセスすると、Read 関数を呼び出すことができます。

5. Azure Functions のプロキシ機能を設定

ここまでの作業で、Web API は最低限動作するようになりました。

しかし、id を指定するには /api/Read?id=abc123 のようにクエリパラメータとして指定しなければなりません。本資料の一番最初で説明したように、今回は /tasks/{id} という形式にしたいです。

また、https://mstechcamp-api.azurewebsites.net/tasks という1つの URL に対して、HTTP メソッドが GET の場合は Read 関数を呼び出し、POST の場合は Create 関数を呼び出したいです。

Azure Functions のプロキシ機能を設定することで、これらを実現できます。設定手順は以下の通りです。

関数アプリの プロキシ ページに移動します。

追加を選択します。以下の設定値を入力して、作成を選択します。これをエンドポイントごとに実施します。

`GET /tasks`

項目	設定値
名前	task-read
ルートテンプレート	/tasks
許可されている HTTP メソッド	選択したメソッド（GET）
バックエンド URL	（Read 関数の URL）

`GET /tasks/{id}`

項目	設定値
名前	task-read-id
ルートテンプレート	/tasks/{id}
許可されている HTTP メソッド	選択したメソッド（GET）
バックエンド URL	（Read 関数の URL）
[要求のオーバーライド] クエリ	id と {id}

`POST /tasks`

項目	設定値
名前	task-create
ルートテンプレート	/tasks
許可されている HTTP メソッド	選択したメソッド（POST）
バックエンド URL	（Create 関数の URL）

合計で3つのプロキシが作成されていることを確認します。

プロキシの設定は以上です。これで Web API が完成しました！

6. 動作確認

お好みのツール（例えば API Tester）を使用して、作成した Web API の動作を確認してみましょう。

次の画像では、ブラウザを使って、タスク一覧取得 API の動作を確認しています。

7. リソースを削除

最後に、作成したリソースを削除する方法を紹介します。

Azure portal から リソースグループ を選択し、作成したリソースグループ名（例えば mstechcamp）を選択します。

リソースグループの削除 を選択し、確認のためリソースグループ名（例えば mstechcamp）をテキストボックスに入力して、削除を選択します。

お疲れ様でした！

おわりに

ハンズオンはこれで終わりですが、今回のハンズオンの応用例や補足事項を紹介します。

Azure Static Web Apps を使うと、今回作成した Web API を利用する Web サイトを簡単＆無料で公開することができます。素晴らしいハンズオン資料がこちらから利用できます。

Cosmos DB を無料枠内で運用していくには、いくつか気をつけるべきポイントがあります。わかりやすいまとめが Azure Cosmos DB の無償枠 (Free Tier) の注意点にあります。

アンケート

アンケートにご協力ください！

https://forms.gle/kM2hVH9YSHMFcpsw7

Name		Name	Last commit message	Last commit date
Latest commit History 4 Commits
img		img
README.md		README.md
slide.pdf		slide.pdf

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

MS Tech camp #4 ~Azure Functions と Cosmos DB でサーバレス Web API を作ろう！~

目次

1. Azure Cosmos DB アカウントを作成

2. Azure Cosmos DB コンテナーを作成

3. Azure Functions の関数アプリを作成

4. Azure Functions の関数を作成

4.1 Create 関数を追加

4.2 Create 関数をテスト

4.3 Read 関数を追加

4.4 Read 関数をテスト

5. Azure Functions のプロキシ機能を設定

`GET /tasks`

`GET /tasks/{id}`

`POST /tasks`

6. 動作確認

7. リソースを削除

おわりに

アンケート

参考

About

Releases

Packages

mspjp/function-cosmosdb-webapi

Folders and files

Latest commit

History

Repository files navigation

MS Tech camp #4 ~Azure Functions と Cosmos DB でサーバレス Web API を作ろう！~

目次

1. Azure Cosmos DB アカウントを作成

2. Azure Cosmos DB コンテナーを作成

3. Azure Functions の関数アプリを作成

4. Azure Functions の関数を作成

4.1 Create 関数を追加

4.2 Create 関数をテスト

4.3 Read 関数を追加

4.4 Read 関数をテスト

5. Azure Functions のプロキシ機能を設定

GET /tasks

GET /tasks/{id}

POST /tasks

6. 動作確認

7. リソースを削除

おわりに

アンケート

参考

About

Resources

Stars

Watchers

Forks

Releases

Packages 0

`GET /tasks`

`GET /tasks/{id}`

`POST /tasks`

Packages