API GatewayでPOST用のMockを作る

投稿日：3月 13, 2022

webアプリ等でPOSTメソッドのチェックをする際にMockと呼ばれるPOSTメソッドを受けてレスポンスしてくれる擬似的なサーバを立てることがあります。

今回、AWSの学習を兼ねてAPI GatewayでPOST用のMockを作成しました。

API GatewayでAPIを作成

APIを作成します。

REST APIの構築を行います。

API名を今回は「MyPostAPI」としてAPIの作成に進みます。

アクションのメソッドの作成を選択します。

POSTを選択、統合タイプをMockとして保存します。

保存すると以下の画面となります。

この段階で左側のテストを開いて、リクエスト本文に以下を入力してテストしたところ、

ステータス：200となりましたが、レスポンス本文が「no data」となっていました。

ステータス：200となった時にレスポンスするメッセージを作成します。

メソッドの実行に戻り、統合レスポンスを選択します。

マッピングテンプレートを追加し、テンプレートの内容として以下を入力し、保存します。

{
    "statusCode": 200,
    "message": "Go ahead without me."
}

再度テストを実行すると、レスポンス本文にテンプレートで追加した内容が表示されました。

では作成したAPIを公開してみます。

アクションからAPIのデプロイを選択します。

デプロイされるステージを[新しいステージ]、ステージ名はdevとしてデプロイします。

デプロイするとURLの呼び出しが表示されます。

APIが使えるようになったかPostmanを使って確認したところ、正しくレスポンスされることが確認できました。

API Gatewayを使ったPOST用のMockを作成しました。

今回はとりあえず動くだけという形でしたが、POST内容の検証やAPIキー設定についても試そうと思います。

APIやHTTPに関する基本的なことは以下の本がわかりやすいのでオススメです。