LaravelでSSOのAPIを作成（API側）

「LaravelでSSOのAPIを作成する」シリーズの第二回です。

前回はイントロをエントリーしました。

LaravelでSSOのAPIを作成（イントロ）

今回はSSOのAPIを作成します。

 

仕様

SSOのAPI は Laravel で構築していきます。

ログイン画面で「メールアドレス」「パスワード」をPOST送信し、API側でリクエストを受け取って DB と照合をかけるスクリプトを書きます。

結果はJSON形式 ( response()->json ) に変換して返します。

クライアント側ではJSONだと使いにくいので StdClass に変換して結果を使います。

 

APIの作成

 

手順

 

１）Laravelのインストール＆設定

Laravel のインストールや設定については、すでにこのブログでいくつかエントリーしているので割愛します。

【参照】Laravel ローカル環境構築（for XAMPP）

cd C:\xampp\htdocs
composer create-project "laravel/laravel=5.2.*" ssoapi

 

２）DB＆モデルの作成

１．マイグレーションファイルの作成

とりあえず、デフォルトでついているマイグレーションファイルを使います。

そのままマイグレーションコマンドを実行。

$ php artisan migrate
Migration table created successfully.
Migrated: 2014_10_12_000000_create_users_table
Migrated: 2014_10_12_100000_create_password_resets_table

 

２．シーダーファイルの作成

usersテーブルの「ユーザー名」「email」「パスワード」をデモを入力します。

public function run()
{
\DB::table('users')->insert([
'name' => 'デモ ユーザー',
'email' => 'demo@gmail.com',
'password' => 'secret',
]);
}

 
細かい手順については以下を参照してください。

シーダーについて（基本）

 

３．モデルの作成

Userテーブルを操作するモデルを作成します。

php artisan make:model Models/User

 
artisanコマンドで生成されたスケルトンを編集。

カラムにデータを挿入できるようにします。

protected $table = 'users';
protected $primaryKey = 'id';
protected $fillable = [
'name'
, 'email'
, 'password'
];

 
細かい手順については以下を参照してください。

モデルの作成

 

３）コントローラの作成

artisanコマンドでコントローラのスケルトンを作成。

php artisan make:controller UserController

 
自動生成されたコントローラを編集します。

// Requestファサードを利用するためにエイリアス作成
use Request;

class UserController extends Controller
{
//
public function login()
{
// 初期設定
$result = false;
$message = '';

// リクエスト取得
$id = Request::input('id');
$password = Request::input('password');

if(empty($id))
{
$message = 'not input id';
}elseif(empty($password))
{
$message = 'not input password';
}else{
// id & pass あり → データ検索
if(strstr($id, '@')) // "@" があるかチェック
{
$findData = \App\Models\User::where('email', $id)->where('password',$password)->first();
}

if(empty($findData))
{
// レコードなし
$message = 'nothing';
}else{
// レコードあり
$result = true;
}
}

// レスポンス生成
if($result)
{
// 該当レコードありの処理
$response = response()->json(
[
'result' => $result
,'id' => $findData->id
,'email' => $findData->email
,'password' => $findData->password
,'name' => $findData->name
,'message' => 'ログイン成功！'
]
);
}else{
//該当レコードなしの処理
$response = response()->json(
[
'result' => $result
,'message' => $message
]
);
}
return $response;
}

 

４）ルーティングの作成

http://localhost/practice_sso/public/login でアクセスしたら UserController の login メソッド実行

Route::post('login', 'UserController@login');

 

５）特定ルートの csrf_token のチェックを無効

Laravelの場合、外部から POST される場合、csrf_token のチェックを無効にする必要があります。

app/Http/Middleware/VerifyCsrfToken.php の $except に除外する URI を追加します。

# app\Http\Middleware\VerifyCsrfToken.php
:
namespace App\Http\Middleware;

use Illuminate\Foundation\Http\Middleware\VerifyCsrfToken as BaseVerifier;

class VerifyCsrfToken extends BaseVerifier
{
    protected $except = [
        'login/', // csrf_tokenを除外するURIを記述
    ];
}

 
API側の作業は以上になります。

次回はクライアント側の作成をします。

 

 

 

-チュートリアル, 上級