Laravel標準の会員登録機能をAPIから叩いてみる

認証機能は自作ではなく、、できるだけLaravelで標準で用意されているものを使うべきです。
というわけで、今回はLaravel標準で用意されている会員登録機能をAPIから叩いてみます！

まずは、RegisterControllerを作成します。

php artisan make:controller Api/Auth/RegisterController

そして、Controllerの中身をこのように変更します。
traitでLaravelの認証機能を使用する感じです。

registerメソッドの中で、会員登録の処理を書きます。
createメソッドの中で、作成するユーザー情報を定義します。データ加工が必要な場合もここで行うと良いでしょう。

<?php

namespace App\Http\Controllers\Api\Auth;

use App\Http\Controllers\Controller;
use App\Models\User;
use Illuminate\Support\Facades\Auth;
use Illuminate\Auth\Events\Registered;
use Illuminate\Foundation\Auth\RegistersUsers;
use Illuminate\Support\Facades\Hash;

class RegisterController extends Controller
{
    use RegistersUsers;

    public function register()
    {
        $this->validator(request()->all())->validate();
        event(new Registered($user = $this->create(request()->all())));
        $this->guard()->login($user);
        return ['success' => true, 'user' => $user];
    }

    protected function create(array $data)
    {
        return User::create([
            'name'  => $data['name'],
            'email' => $data['email'],
            'password' => Hash::make($data['password']),
        ]);
    }
}

ルーティングも定義します。

use App\Http\Controllers\Api\Auth\RegisterController;
Route::post('register', [RegisterController::class, 'register']);

これでOK

本人確認メールも送るようにする

ちなみにLaravel標準の会員登録では、会員登録時に本人確認メールが飛ぶようにすることも容易にできます。

User.phpにimplements MustVerifyEmailを追記します

class User extends Authenticatable implements MustVerifyEmail // ← ここ
{

そして、このままではLaravel標準で用意されているメールが送信されてしまうので、認証メールを送信するためのメソッドをオーバーライドします（User.phpです）

public function sendEmailVerificationNotification()
{
    $this->notify(new UserVerifyNotification());
}

次に認証メールの方を定義します
UserVerifyNotification を作成していきます

php artisan make:notification UserVerifyNotification

あとは好きに通知タイトルや本文を好きにしていただいて大丈夫です。
例として、UserVerifyNotificationをこのようにします

<?php

namespace App\Notifications;

use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Notifications\Messages\MailMessage;
use Illuminate\Auth\Notifications\VerifyEmail;
use Illuminate\Support\Facades\Auth;

class UserVerifyNotification extends VerifyEmail
{
    use Queueable;

    /**
     * Create a new notification instance.
     *
     * @return void
     */
    public function __construct()
    {
    }

    /**
     * Get the notification's delivery channels.
     *
     * @param  mixed  $notifiable
     * @return array
     */
    public function via($notifiable)
    {
        return ['mail'];
    }

    /**
     * Get the mail representation of the notification.
     *
     * @param  mixed  $notifiable
     * @return \Illuminate\Notifications\Messages\MailMessage
     */
    public function toMail($notifiable)
    {
        $settingUrl = $this->verificationUrl($notifiable);     //verificationUrl required for the verification link
        return (new MailMessage())
            ->subject('本人メール確認')
            ->view('emails.verify', [
                'name' => $notifiable->name,
                'setting_url' => $settingUrl,
            ]);
    }

    /**
     * Get the array representation of the notification.
     *
     * @param  mixed  $notifiable
     * @return array
     */
    public function toArray($notifiable)
    {
        return [
            'setting_url' => $this->settingUrl
        ];
    }
}

メール本文をbladeで書いていきます
resources/views/emails/verify.blade.php を作り中身を埋めていきます。

{{ $name }} 様<br>
<br>
いつもサービスをご利用いただき、誠にありがとうございます。<br>
ログインURL：{{ $setting_url }}<br>
<br>
※本メールは自動送信されています。

以上です！！

テストを作る

テストを作ります

php artisan make:test RegisterController/RegisterTest

テストはこんな感じでOKです

ユーザーが登録されているか、メールは送信されているか、認証しているかをチェックしています。

<?php

namespace Tests\Feature\RegisterController;

use App\Enums\UserType;
use App\Mail\UserRegisterMail;
use App\Models\ClientInvite;
use App\Models\User;
use App\Notifications\UserVerifyNotification;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Illuminate\Foundation\Testing\WithFaker;
use Illuminate\Support\Facades\Notification;
use Tests\TestCase;

class RegisterTest extends TestCase
{
    use RefreshDatabase;
    use WithFaker;

    /**
     * 会員登録処理を実行する（成功）
     *
     * @return void
     */
    public function testRegisterSuccess()
    {
        Notification::fake();

        $param = ["name", "email", "password"]:

        $response = $this->post('/api/register', $param);
        $response->assertStatus(200);

        // DBに保存されていることを確認
        $this->assertDatabaseHas('users', [
            'name' => $param['name'],
            "email" => $param["email"]
        ]);

        // 認証していることを確認
        $createdUser = User::latest('id')->first();
        $this->assertAuthenticatedAs($createdUser, 'user');

        Notification::assertSentTo(
            $createdUser,
            UserVerifyNotification::class,
        );
    }
}