LaravelでAPIを作る基本!ルーティングとレスポンスの基本構成をやさしく解説
生徒
「LaravelでAPIを作るって聞いたんですが、そもそもAPIって何ですか?」
先生
「APIは、プログラム同士が情報をやり取りするための窓口のようなものです。人が画面を見る代わりに、プログラムがデータを受け取ります。」
生徒
「画面がないのに、どうやって使うんですか?」
先生
「URLにアクセスすると、文字のデータが返ってくる仕組みです。Laravelでは、その入り口をルーティングで決めます。」
生徒
「難しそうですが、パソコン初心者でも大丈夫ですか?」
先生
「大丈夫です。家のインターホンに例えると、とても分かりやすくなりますよ。」
1. Laravelで作るAPIとは?
LaravelのAPI開発とは、画面を表示しないプログラムを作ることです。 普段使っているWebサイトは、文字や画像が表示されますが、APIはデータだけを返します。 このデータは、スマートフォンアプリや別のシステムから利用されます。
APIは、レストランの「注文口」のような存在です。 お客さんが「この料理をください」と注文すると、厨房から料理が出てきます。 LaravelのAPIも同じで、「このURLにアクセスされたら、このデータを返す」という決まりを作ります。
Laravelは、PHPで作られたWebフレームワークです。 フレームワークとは、あらかじめ便利な道具箱が用意されている仕組みのことです。 そのため、プログラミング未経験者でも、API開発を始めやすくなっています。
2. API開発で重要な「ルーティング」とは?
ルーティングとは、「どのURLに、どんな処理をするか」を決める仕組みです。 これは、家のインターホンの番号表のようなものです。 101号室を押したらAさん、102号室を押したらBさん、という対応を決めます。
Laravelでは、API専用のルーティングファイルとして、
routes/api.php が用意されています。
このファイルに書いたルールは、APIとして動作します。
URLにアクセスされたときに、どの処理を行うかを明確にすることで、 APIが正しくデータを返せるようになります。 これがLaravelのルーティングの基本です。
3. LaravelでAPIルーティングを書いてみよう
それでは、実際にLaravelでAPIルーティングを書いてみましょう。 まずは「アクセスされたら、文字を返すだけ」のとても簡単な例です。
Route::get('/hello', function () {
return 'こんにちは、Laravel APIです';
});
このコードの意味を順番に説明します。
Route::get は、「GET通信」という方法でアクセスされたときのルールです。
GET通信とは、情報を取りに行くためのアクセス方法です。
/hello はURLの一部です。
ブラウザで /api/hello にアクセスすると、この処理が実行されます。
return は、「結果を返す」という意味のPHPの命令です。
今回は文字を返しているので、そのまま画面に表示されます。
こんにちは、Laravel APIです
4. APIレスポンスとは何か?
APIレスポンスとは、APIが利用者に返す結果のことです。 人が読む文章ではなく、プログラムが理解しやすい形で返すのが特徴です。
LaravelのAPIでは、よく「JSON(ジェイソン)」形式が使われます。 JSONとは、データを整理して書くためのルールです。 名前や数字をセットで管理できるので、とても便利です。
JSONは、住所録のようなイメージです。 「名前」「年齢」「住所」といった情報を、分かりやすくまとめます。 Laravelは、このJSONレスポンスを簡単に作ることができます。
5. LaravelでJSONレスポンスを返す方法
次に、LaravelでJSON形式のレスポンスを返す例を見てみましょう。 API開発では、この形がとてもよく使われます。
Route::get('/user', function () {
return response()->json([
'name' => '山田太郎',
'age' => 20
]);
});
response() は、Laravelが用意しているレスポンス専用の道具です。
json を使うことで、データをJSON形式に変換して返します。
配列の中に、name や age を書くことで、
「名前」と「年齢」というデータをまとめています。
これがAPIレスポンスの基本構造です。
{"name":"山田太郎","age":20}
6. APIルーティングとレスポンスの関係
LaravelのAPI開発では、 ルーティングが入り口、レスポンスが出口になります。 URLにアクセスされると、ルーティングが反応し、 決められたレスポンスを返します。
この流れを理解することで、 APIがどのように動いているかが見えてきます。 最初は「URLと返ってくるデータが結びついている」 と覚えるだけで十分です。
Laravelは、この仕組みをシンプルに書けるように設計されています。 そのため、初心者でもAPI開発の基本をしっかり学ぶことができます。