Lravelで簡単なAPIを作ってみよう！

そもそもAPIってなに？

「API」とは、「Application Programming Interface」の略で、ソフトウェアやプログラム、Webサービスの間をつなぐインターフェースのことを指します。

ソフトウェアやアプリケーションなどの一部を外部に向けて公開することにより、第三者が開発したソフトウェアと機能を共有できるようにしてくれるものです。

長々と書きましたが、要するに「こういう動作をしてくれ」と要求すれば決まった結果を返してくれるものなのです。

どこからでもアクセスできる口を開けておき、決まった形式でアクセスを受け付けて、仕様通りの結果を返すインターフェースとなるのがAPIです。

Web上で公開されている APIの中では「Facebook」「Twitter」「YouTube」「Googleマップ」などが有名で、ほかにも、気象情報、グルメ紹介、テレビ番組表、交通データ、観光情報などのさまざまなAPIがあります。今となってはスマートフォン向けのサービスやアプリ開発には欠かせない存在となっています。

実際に作ってみよう！

今回は簡単な文言をJSON形式で返すAPIを作っていきます。
必要なステップはたったの２つです！

・コントローラーの作成

・ルーティングの設定

1.コントローラーの作成

新しいプロジェクトの中に、まずはコントローラーを作成します。

php artisan make:controller HelloController

これでapp/Http/Controllersフォルダ内にHelloControllerが作成されたので、コントローラー内にメソッドを記述します。

class HelloController extends Controller
{
    public function getMessage(){
        return response()->json([‘message’ => ‘Hello’]);
    }
}

HelloController として、呼び出されたとき、json化された連想配列を返すというものです。

2.ルーティングの設定

次にルーティングの設定です。

Web用のルーティングはweb.phpに定義しますが、APIの場合api.phpにルーティングを定義しないといけないので、注意してください。
書き方はweb.phpのときと同じで大丈夫です。

use Illuminate\Support\Facades\Route;
use App\Http\Controllers\HelloController;

Route::get(‘/hello’, [HelloController::class, ‘get’Hello]);

以上で完成です。たった２つのステップでできてしまいます。

動作確認

APIを実行し、動作を確認してみましょう。

ターミナルでサーバーを立ち上げます。

php artisan serve

http://localhhost:8000/hello にアクセスしてみてください。

{“message:”Hello”}　と、値が返ってきていたら成功です！

APIの動作確認の方法としては他にもPostmanという便利ツールがあるので、こちらもぜひ活用してみてください。→https://www.postman.com/

以上、非常にシンプルですがAPIを作ることができました。

今後データベースを活用したより実戦的なものであったり、Postmanの活用方法なんかも解説していこうと思います！

engineer

てしま

# PHP

一覧に戻る