
Laravelでログインとトークン認証のAPIを作成してみる(API実装)
前回記事「Laravelでログインとトークン認証のAPIを作成してみる(環境構築)」では、DBのテーブル作成などAPI作成の準備についてまとめていました。今回はログインとトークン認証のAPI作成を引き続きやってみたいと思います。
この時に入力するemailとpasswordはDBに記録されているテストデータと一致するものにしておきます。
ただし、テストデータのパスワードはfactoryで自動生成によるもので暗号化されています。そのため元の平文で入力する必要がありますが、この値は「/database/factories/」にあるそれぞれfactoryファイルで確認できます。デフォルトの値を見ておきます。
【database/factories/UserFactory.php】※一部抜粋
またDBのtokenカラムにも同じ値が記録されているのも確認できます。
成功するとレスポンスボディにDBに登録されているユーザー情報が返ってくるのが確認できます。こちらでも同じくエラーの場合には401のステータスコードが返されます。
DBのtokenカラムを見ても値が戻っているのが確認できます。
今回はLaravelでログインとトークン認証を使った仕組みを試してみました。Laravelを使うとバックエンド側での様々な機能を用意することができますね。また色々と勉強も兼ねて触っていきたいと思います。
ログイン&トークン発行API
まずはログイン用のAPIを作成していきます。このAPIでは合わせてユーザー固有のトークンも発行する内容になっています。routes/api.phpに下記のようにAPIを実装していきます。 【routes/api.php】※一部抜粋Route::post("/login",function(){
$email = request()->get("email");
$password = request()->get("password");
$user = AppUser::where("email",$email)->first();
if ($user && Hash::check($password, $user->password)) {
$token = str_random();
$user->token = $token;
$user->save();
return [
"token" => $token,
"user" => $user
];
}else{
abort(401);
}
});
APIのデバッグには「Postman」などのアプリを使うと便利です。詳しくはこちらの記事「Postmanの導入で捗るAPI開発やデバッグ」にまとめていますのでご参考に
これでPOST http://127.0.0.1:8000/api/login でアクセスし、リクエストボディにJSONの形で下記のようにemailとpasswordを入力して送信してみます。
この時に入力するemailとpasswordはDBに記録されているテストデータと一致するものにしておきます。
ただし、テストデータのパスワードはfactoryで自動生成によるもので暗号化されています。そのため元の平文で入力する必要がありますが、この値は「/database/factories/」にあるそれぞれfactoryファイルで確認できます。デフォルトの値を見ておきます。
【database/factories/UserFactory.php】※一部抜粋
use AppUser;
use IlluminateSupportStr;
use FakerGenerator as Faker;
$factory->define(User::class, function (Faker $faker) {
return [
'name' => $faker->name,
'email' => $faker->unique()->safeEmail,
'email_verified_at' => now(),
// デフォルトの値であるpasswordが暗号化されている
'password' => '$2y$10$92IXUNpkjO0rOQ5byMi.Ye4oKoEa3Ro9llC/.og/at2.uheWG/igi',
'remember_token' => Str::random(10),
];
});
emailとpasswordの認証が成功すると、レスポンスボディにトークンが発行されているのが確認できます。ステータスコードも200が返ってきているので成功しています。エラーの場合は401のステータスコードが返ってくる形になります。
またDBのtokenカラムにも同じ値が記録されているのも確認できます。
トークン認証API
続いてトークンの認証を行うAPIを実装していきます。イメージとしては、ユーザーの個別マイページを表示させるような機能に使えます。同じくroutes/api.phpに下記のようにAPIを実装していきます。 【routes/api.php】※一部抜粋Route::get("/mypage",function(){
$token = request()->bearerToken();
$user = AppUser::where("token",$token)->first();
if ($token && $user) {
return [
"user" => $user
];
}else{
abort(401);
}
});
GET http://127.0.0.1:8000/api/mypage でアクセスし、リクエストヘッダの「authorization」のタイプを「Bearer Token」に指定し、tokenの値に先ほど発行されたものを入れて送信します。
成功するとレスポンスボディにDBに登録されているユーザー情報が返ってくるのが確認できます。こちらでも同じくエラーの場合には401のステータスコードが返されます。
ログアウトAPI
そしてログアウト用のAPIも用意しておきます。こちらも同じくroutes/api.phpに下記のようにAPIを実装していきます。 【routes/api.php】※一部抜粋Route::post("/logout",function(){
$token = request()->bearerToken();
$user = AppUser::where("token",$token)->first();
if ($token && $user) {
$user->token = null;
$user->save();
return [];
}else{
abort(401);
}
});
POST http://127.0.0.1:8000/api/logout でアクセスし、そのまま送信すると、トークンの値はnullになりログアウトされます。
DBのtokenカラムを見ても値が戻っているのが確認できます。
今回はLaravelでログインとトークン認証を使った仕組みを試してみました。Laravelを使うとバックエンド側での様々な機能を用意することができますね。また色々と勉強も兼ねて触っていきたいと思います。categories
- WordPress(61)
- JavaScript(49)
- Vue.js(48)
- CSS(46)
- jQuery(34)
- Nuxt.js(22)
- Sass(21)
- Gulp(17)
- webpack(16)
- PHP(14)
- HTML(14)
- GSAP(11)
- React(10)
- Vite(9)
- Pug(9)
- Laravel(8)
- Cordova(8)
- Linux(7)
- Next.js(6)
- Apache(5)
- Shopify(4)
- REST API(4)
- Node.js(4)
- Smarty(3)
- Git(3)
- JSON(3)
- その他プログラミング(3)
- Google Apps API(3)
- Bootstrap(3)
- 環境構築・システム(3)
- TypeScript(2)
- EJS(2)
- RMS(2)
- Docker(2)
- Instagram API(2)
- Excel VBA(2)
- SVG(1)
- Dart(1)
- ECカートASP(1)
- Markdown(1)
- AMP(1)
- Nginx(1)
- XML(1)
- shellscript(1)
- Ruby(1)
- MySQL(1)