【Laravel】APIのコントローラーを作成するのに便利なapiオプションを解説します

こんにちは。たいら(@tairaengineer2)です。
転職を繰り返し現在4社経験している、11年目エンジニアです。

この記事では、 LaravelのAPIのコントローラーを作成するのに便利なapiオプションについて解説していきます。

前提条件：実行環境について
apiオプションとは
まとめ：APIのコントローラーを作成するときはapiオプションを使ってみよう

前提条件：実行環境について

実行環境は以下の通りです。

OS	Windows10
PHPのバージョン	8.0.3
Laravelのバージョン	8.42.1

この記事では

C:\Laravel\LaravelSample

配下にLaravelのプロジェクトを作成しています。

apiオプションとは

apiオプションとは、APIで使うであろう関数がすでに用意されている状態でコントローラーを作成することができる、便利なオプションです。
apiオプションは、コントローラーを作成するコマンドに追加して使うオプションです。

コントローラーを作成するコマンドは以下でした。

php artisan  make:controller 【作成するコントローラーの名前】

1	php artisan make:controller 【作成するコントローラーの名前】

詳細な説明については、こちらの記事をご参考ください。

【Laravel】コントローラーを新規作成するartisan make:controllerコマンドを解説します

apiオプションをつけると以下のようなコマンドになります。

php artisan make:controller 【作成するコントローラーの名前】 --api

1	php artisan make:controller 【作成するコントローラーの名前】 --api

作成するコントローラーの後ろに【–api】をつければOKです。

apiオプションをつけてコマンドを実行すると、オプションをつけずに実行したときの同じように

Controller created successfully.

が表示されます。

新規作成されたコントローラーの中身は↓のようになっています。

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class ApiSampleController extends Controller
{
    /**
     * Display a listing of the resource.
     *
     * @return \Illuminate\Http\Response
     */
    public function index()
    {
        //
    }

    /**
     * Store a newly created resource in storage.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return \Illuminate\Http\Response
     */
    public function store(Request $request)
    {
        //
    }

    /**
     * Display the specified resource.
     *
     * @param  int  $id
     * @return \Illuminate\Http\Response
     */
    public function show($id)
    {
        //
    }

    /**
     * Update the specified resource in storage.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  int  $id
     * @return \Illuminate\Http\Response
     */
    public function update(Request $request, $id)
    {
        //
    }

    /**
     * Remove the specified resource from storage.
     *
     * @param  int  $id
     * @return \Illuminate\Http\Response
     */
    public function destroy($id)
    {
        //
    }
}

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class ApiSampleController extends Controller

{

/**

* Display a listing of the resource.

* @return \Illuminate\Http\Response

public function index()

{

}

/**

* Store a newly created resource in storage.

* @param \Illuminate\Http\Request $request

* @return \Illuminate\Http\Response

public function store(Request $request)

{

}

/**

* Display the specified resource.

* @param int $id

* @return \Illuminate\Http\Response

public function show($id)

{

}

/**

* Update the specified resource in storage.

* @param \Illuminate\Http\Request $request

* @param int $id

* @return \Illuminate\Http\Response

public function update(Request $request, $id)

{

}

/**

* Remove the specified resource from storage.

* @param int $id

* @return \Illuminate\Http\Response

public function destroy($id)

{

}

このようにAPIで使うであろう関数があるので、APIを作成するのにとても便利なオプションです。

まとめ：APIのコントローラーを作成するときはapiオプションを使ってみよう

以上がLaravelのAPIのコントローラーを作成するのに便利なapiオプションの解説でした！

あなたのご参考になったのなら、とても嬉しいです(*´▽｀*)
ではでは～(・ω・)ﾉｼ