はじめに
こんにちは、ユーゴです。
最近、趣味でクラウドプラットフォームを遊んでいます。AWS, GCP, Azureなど色々と試しており、「こんなことができるのか、すげ〜」という感じです。
今回は、AWSを使用して、「とにかくAPIを自作してみたい！」という方に実装方法を紹介します。
結論
- 「Lambda」でバックエンドを作成
- 「API Gateway」でエンドポイントを作成
これだけで、APIを実装できます。しかも、今回はGUI操作で完結します。
対象読者
・サーバーなんもワカランの人
→ 今回は、サーバーレスで実装できます。AWS偉大。GASのデプロイと似たような感じです(GASでもAPIは作れるけど、APIのためのデプロイという感じではないので、APIを体系的に学習できない)
・APIはちょっと分かるの人
→ 「Slack API 叩いてみたことはある」という感じで、なんとなくAPIがどういうものか分かっていれば十分です
0. AWSアカウントを作成
今回は、APIを作成するために、AWSを使用して構築していきます。そのため、まずはAWSアカウントを作成しましょう。
こちらからアカウント作成が可能です。
AWS Console - Signup
よくあるサービス登録の手順なので、指示に従っていけば簡単に作成できると思います。
1. 「Lambda」でバックエンドを作成
AWSのコンソールにアクセスできたら、画面上部の検索バーに「Lambda」と入力し、「Lambda」をクリックします。
画面が遷移したら、やや右上にある「関数の作成」をクリックします。
①：関数名を入力します。今回は「qiita_test」としました。
②：言語を選択します。今回は「Python3.12」を選択しました。
どちらもお好みで入力してください。
入力できたら、右下の「関数の作成」を押します。
すると、数秒後に以下のような画面に遷移します。
通常は「コードソース」の部分で、バックエンドを書いていきます。が、今回はデフォルトのままにします。何が行われているかというと、APIがコールされたら、レスポンスとして以下を返します。
{
'statusCode':200,
'body':JSON.dumps('Hello from Lambda!')
}
2. 「API Gateway」でエンドポイントを作成
画面上部の検索バーから、「api」と入力すると、「API Gateway」が出てくると思うので、それをクリックします。
すると、初回は以下のような画面が出てきます。今回は「REST API」で構築します。「REST API」の「構築」をクリックしてください。
画面が遷移すると、以下のようになります。
「API名」を入力してください。今回は、「qiita_test_api」としました。
入力したら、「APIを作成」ボタンをクリックしてください。
しばらくすると、以下のような画面になります。
「リソースを作成」をクリックしてください。
しばらくすると、以下のような画面になります。
「リソース名」を入力してください。このリソース名は、APIを叩くときのURLに含まれます。今回の例だと、「http://〜〜〜/sample」というようになります。「〜〜〜」の部分は後ほど自動で割り当てられます。
入力したら、「リソースを作成」ボタンを押してください。
しばらく待つと、作成されたのが確認できます。
作成されたリソース(今回は「sample」)が選択されているのを確認し、「メソッドを作成」ボタンをクリックします。
画面が遷移したら、以下のようになります。
まず、「メソッドタイプ」を「GET」にします。
次に、「Lambda関数」の入力フィールドをクリックすると、作成したLambda関数一覧が表示されます。arnとはリソースを一意に識別するUIDのようなものです。末尾に、自分で決めた関数名も足されているので、すぐに見つけられます。
入力したら、「メソッドを作成」ボタンを押します。
しばらくすると、GETが作成されたことが確認できます。
次に、「APIをデプロイ」ボタンをクリックしてください。
ポップアップが出てきたら、「ステージを選択」をクリックし、
「新しいステージ」をクリックし、
ステージ名を入力します。今回は「wip」としました。「dev」や「prod」など、必要に合わせて命名を考えてください。こちらも、「http://〜〜〜/wip/sample」のように、エンドポイントに含まれます。
入力したら、「デプロイ」を押します。
デプロイすると、以下のような画面になります。
赤枠が、APIのエンドポイントです。「エンドポイント/リソース」というようなURLになります。
URLはコピーしておきましょう。画面を変えてしまっても、後から左のメニューで「ステージ」を選択すると確認できます。
3. 確認
ターミナルで、curlを使って確認します。なお、確認方法はPostmanでもなんでもいいです。GASでUrlfetchしてもいいです。
curl 'https://{ID}.execute-api.ap-northeast-1.amazonaws.com/wip/sample'
{"statusCode": 200, "body": "\"Hello from Lambda!\""}
【補足】
・{ID}の部分は、APIデプロイ時のものをコピーしておけば気にしなくて大丈夫です。
・コピーしたURLに加えて、「sample」のようにリソース名を忘れないでください。
まとめ
いかがだったでしょうか。今回は、AWSを使ったAPI実装の超入門編を紹介しました。
CI/CDにハマっていた時、Unityの成果物を自動で商品としてパッケージングするフローを作成しており、その一環で自分でAPIを作ってみたいと思ったのですが、「サーバーを立てる」「ポート開放する」「エンドポイントを設定する」など、ワケワカランの連続でした。その後紆余曲折しているうちに、AWSにたどり着いたという経緯がありました。今となっては、オンプレでサーバー立てて、マシンとルーターでポート開放の設定をして、fast apiでエンドポイントを設定して...というのもできるようになりましたが、まずはAWSでAPIをざっくりと作れるようになれると良いと思います。それに、今回のようにクラウドでも実務としてAPIを作ることはあると思います。個人情報などコンプラ的にオンプレの方がいいなどがあったときに、生々しいAPI作成の道を学習すれば良いかと思います。
AWSはこれだけでなく、
・サーバーを物理で用意しなくても構築できる(EC2)
・データベースをクラウド上で構築できる(RDS)
・ウェブアプリケーションをホストできる(Amplify)
といった具合で、とても多機能で便利なプラットフォームです。ゲーム畑の人間でしたが、大規模なゲーム開発でも基盤にできるのではないかと考えています。
また、クラウドプラットフォームはAWSに限らず、GCPやAzureなどたくさん種類があるので、お好みやプロジェクトに合わせて、選定してみてください。
このように、クラウドプラットフォームの扱い方から、Unityでゲーム制作に役立つ情報まで、プログラミングに関わる幅広い知見を取り扱っています。お役に立てましたら、いいね, LGTM, フォロー等よろしくお願いいたします！