ヤマムギ

growing hard days.

*

Amazon API Gatewayでモックを作る

   


超シンプルなAPI Gatewayのサンプルがほしかったので、ユーザーガイドの手順でモックを作りました。

手順はこちらです。
Amazon API Gateway でモック統合を使用して REST API を作成する

APIの作成

API Gatewayコンソールで[APIの作成]ボタンを押下して、REST APIを選択して、[構築]ボタンを押下しました。

[新しいAPI]のまま、[API名]に任意の名前を入力して、[APIの作成]ボタンを押下しました。

APIができましたので、[アクション]-[メソッドの作成]で[GET]を選択してチェックして作成します。
統合タイプで[Mock]を選択して、[保存]ボタンを押下しました。

APIにGETメソッドが作成できました。

メソッドリクエストの設定

[メソッドリクエスト]を選択して設定をします。

[クエリ文字列の追加]リンクを選択して、クエリ文字列を追加します。
myParamと入力して、チェックマークを押下して保存しました。

[メソッドの実行]リンクを選択して、メソッド設定画面へ戻ります。

統合リクエストの設定

[統合リクエスト]を選択して設定をします。

[マッピングテンプレート]を展開して、Content-Typeですでに設定されている、application/json を選択します。
リクエスト内容を以下に書き換えます。

リクエストクエリのmyParamがmyValueのときに、statusCode 200を送信するリクエストを定義しています。
本来であれば、APIリクエストによって実行されるバックエンドの処理によって、成功であれば200、エラーの場合は500などのレスポンスになりますが、今回はモックを作っているので、リクエストによってコードを送信しています。

[保存]ボタンを押下しました。

[メソッドの実行]リンクを選択して、メソッド設定画面へ戻りました。

メソッドレスポンスの設定

[メソッドレスポンス]を選択して設定しました。

[レスポンスの追加]リンクを選択して、500を入力してチェックマークで保存しました。

[メソッドの実行]リンクを選択して、メソッド設定画面へ戻りました。

統合レスポンスの設定

[統合レスポンス]を選択して設定しました。

200レスポンスを展開して、マッピングテンプレートを選択して、application/jsonを選択して、テンプレートの内容を以下にしました。

ステータスコードが200の成功時に返すメッセージを定義しています。

[保存]ボタンを押下しました。

200レスポンスのセクションを省略しました。

[統合レスポンスの追加]リンクを選択しました。

HTTPステータスの正規表現に “5\d{2}” と入力しました。
メソッドレスポンスステータスで 500 を選択しました。
[保存]ボタンを押下しました。

追加した500レスポンスを展開して、マッピングテンプレートで application/json を入力し、内容を以下にしました。

[保存]ボタンを押下しました。

[メソッドの実行]リンクを選択して、メソッド設定画面へ戻りました。

テストを実行

[テスト]を選択してテストを実行します。

[クエリ文字列]に “myParam=myValue” と入力して、[テスト]ボタンを押下しました。
正常に実行されたレスポンスがレスポンス本文に表示されました。

[クエリ文字列]に適当な文字列を設定して、[テスト]ボタンを押下しました。
レスポンス本文にエラーレスポンスが表示されました。

デプロイしてテストする

[アクション]-[APIのデプロイ]を選択しました。
[デプロイされるステージ]は”新しいステージ”にして、ステージ名は任意の値にして、[デプロイ]ボタンを押下しました。

[ステージ]にprodが作成されているので、URL呼び出しリンクをブラウザのURLバーに貼り付けて、後ろにパラメータ “?myParam=myValue” を付加しました。

GETリクエストの結果が表示されました。
成功です!

例えば連携先のAPIが開発中のときなど、仕様に基づいてモックを作っておいて、連携テストを進めておくなど、便利に使えます。


最後までお読みいただきましてありがとうございました!

【PR】 「AWS認定試験対策 AWS クラウドプラクティショナー」という本を書きました。

【PR】 「AWSではじめるLinux入門ガイド」という本を書きました。

 - AWS ,

ad

ad

  関連記事

[JapanTaxi] Athena 指向アナリティクス 〜真面目に手を抜き価値を得よ〜(AWS Summit Tokyo 2017)を聞いてきました

Athenaのユースケースとして聞きにいきましたが、最近触ってるRe:dashも …

AWS Certificate Manager(ACM)メール検証をDNS検証の証明書に差し替えました

ブログの証明書 このブログの証明書の有効期限があと1週間です。 証明書はAWS …

AWS LambdaでS3 Select

RDSスナップショットをS3にエクスポートした、Parquetフォーマットのデー …

Amazon Glacierのプロビジョニングされた迅速取り出し容量をなぜか購入しました

過去1年ぐらいのAWSコストをCost Explorerで見てまして、10/10 …

RDSのスナップショットをS3へエクスポートが日本語マネジメントコンソールでもできるようになってました

RDSスナップショットをS3にエクスポートする新機能を試そうかと思ったのときは、 …

Feedlyのフィードを自動でSlackへ投稿する(AWS Lambda , Amazon DynamoDB)

やりたいこと Feedlyで共有したいフィードに特定のタグを付けます。 特定のタ …

「雲勉 第1回【勉強会:新技術好き!】AWSマネージドサービス勉強会」に行ってきました

「雲勉 第1回【勉強会:新技術好き!】AWSマネージドサービス勉強会」に行ってき …

ヤマムギ vol.8 (AWS)EC2でLinuxサーバー構築ハンズオン 手順

ヤマムギとは from Mitsuhiro Yamashita 「AWSではじめ …

Cloud9 Python3でpipも3にする

このブログは、2019/10/20に書いた、 Cloud9のAMIがCloud9 …

ALBのヘルスチェックでPHPとMySQL接続をチェック

当ブログで504エラーが発生して、オートスケーリングにより自動でインスタンスが置 …