はじめに
こんにちは、ユーゴです！
今回は、API GatewayでAPIキーを設定したく、方法をネットで調べていました。しかし、なかなか見つからず、少し苦労しました。最終的には、試行錯誤しているうちに、とても簡単な方法で実現できました。
この記事で、同じことで悩んでいる方が時間を浪費せず済むようになれば幸いです。
課題
AWSのAPI GatewayでAPIキーの作成〜設定がわからない。
解決
1. LambdaとAPI GatewayでAPIを作成, 設定
1-1. 作成
こちらについては、できる前提でお話しします。
なので、自作APIの実装手順がわからない方は、こちらの記事をご覧ください。
1-2. APIキーを必須化
APIキーを必須化します。
リソースページから、「メソッドリクエスト」タブの「編集」ボタンをクリックしてください。
「APIキーは必須です」をONにします。
ONにしたら、「保存」をクリックします。
2. APIキーを作成する
API Gatewayの左メニューから、「APIキー」を選択します。
そして、「APIキーの作成」ボタンを押します。
設定は以下のような感じで大丈夫です。
大丈夫であれば、「保存」をクリックします。
3. 使用量プランを作成
個人的には、ここが肝心です。というのも、他の記事で言及されておらず、しかしAPIとAPIキーを連携させるために必要だからです。
3-1. 作成
APIの使用をどれだけ許可するかを設定します。
左メニューの「使用量プラン」をクリックして、「使用量プランを作成」ボタンをクリックしましょう。
今回はテストなので、数値はかなり適当に入れました。リクエストのレート、バースト、クォータの設定は、プロジェクトに応じて適切に設定してください。
クォータを9999にするなら、トグルをOFFにして無制限で良かった
大丈夫そうであれば、「使用量プランを作成」をクリックします。
3-2. ステージを関連付ける
作成された使用量プランのページから、「APIステージを追加」をクリックします。
対象のAPIとステージを選択します。(APIとステージは「1. LambdaとAPI GatewayでAPIを作成する」で作成している想定です)
選択したら、「使用量プランに追加」をクリックします。
4. APIキーを使用量プランに対応づける
「2. APIキーを作成する」で作成したAPIキーのページを開きます。
「使用量プランに追加」をクリックします。
使用量プランを、「3. 使用量プランを作成」で作成したものにします。
選択できたら、「保存」をクリックします。
試してみる
APIキーのページで、「APIキー」のカラムからAPIキーをコピーします。(左側のコピーボタンを押してください)
あとは、curlなりpostmanなりで、リクエストを投げてください。
APIキーは、「x-api-key」という項目に入れるのがお決まりです。
curl "{エンドポイント}" --header "x-api-key:{APIキー}"
{"statusCode": 200, "body": "\"Hello from Lambda!\""}
POSTメソッドなら-X POSTをお忘れなく。
まとめ
いかがだったでしょうか。今回は、APIキーの設定方法についてを紹介しました。
とても簡単だし、個人でAPIを公開していく分にはかなり有用な方法だと思います。しかし、なぜかAPIキーの使い方について細かく言及してくれている記事が見つからなかったので、書いてみました。
お役に立てましたら、いいね, LGTM, フォローなどよろしくお願いします！