More than 3 years have passed since last update.

【Rails API 入門】devise-token-auth

Posted at 2020-05-06

はじめに

devise-token-auth とは？

Railsにおけるトークン認証を実現するgemです。

このdevise-token-authを用いることで、新規登録、ログイン・ログアウトなどはもちろんのこと、アプリ各種操作を行う時にheader情報にユーザーの認証情報（トークン）を載せてバックエンド側（RailsのAPI側など）に送ることで、毎回の処理を安全に実行することができます。

そこで今回は、RailsでAPI提供を行う際の devise-token-auth の使い方について解説します。

トークン認証とは？

簡単に言うと、ログイン・ログアウト、新規登録などのユーザー認証を行う方法の1つで、トークンと呼ばれるしるし（トークンの英語訳）のようなものを利用して認証を行います。

トークン認証の他に、cookiesと呼ばれるものを使ったsession認証が有名ですが、RailsをAPI提供として利用する場合、アプリケーションの動作環境がネイティブアプリ（Mac, Windows, android, iOSなど）になることがあります。
これらネイティブアプリでは、cookiesを保存できないことがある（つまり、session認証ができない）ことがあるので、このトークン認証が注目されています（トークン認証とsession認証の違いについて詳しく知りたい方はこちらをご覧下さい）。

初期設定

まずは、APIモードでRailsアプリとデータベースを作成して下さい。

rails new [アプリ名] --api -d [使用するDB] # -d 以降は省略しても構いません

rails db:create

それでは、devise_token_authをGemfileに追加しましょう。

このタイミングでdevise、必要に応じてrack-corsgemを一緒にインストールして下さい。
deviseはdevise_token_authの細かいところをフォローしてくれ、rack-corsはフロントエンドがVue、バックエンドでRailsのAPI提供を行うといった場合に、URL（詳しくはorigin）のアクセスが重複することを許可してくれます。

  gem "devise"
  gem "devise_token_auth"
  gem "rack-cors" # Railsアプリインストール時にコメントアウトされていると思います。

次に、devise、devise_token_authの順にインストールを行いましょう（DBを作成していない場合や、順番を間違えるとエラーが発生するので注意）。

rails g devise:install

rails g devise_token_auth:install User auth

これで準備は完了です！

次からは実際に、認証機能を実装していきましょう！

認証機能実装

APIのバージョンを管理をする（v1、v2など）ことが多いと思いますので、その想定で実装していきます。

まずは、devise_token_authを用いた認証を行うコントローラーを作成します。

rails g controller v1/auth/registrations

すると、app/controllers/v1/auth/registrations_controller.rbが作成されるので、それを以下内容に修正して下さい。

v1/auth/registrations_controller.rb

class V1::Auth::RegistrationsController < DeviseTokenAuth::RegistrationsController
end

これは何をしているのか？と言いますと、devise_token_authgemであらかじめ用意されている認証用のコントローラーを、作成したregistrations_controllerに継承しています。

継承したコントローラーを使用し、次の内容のルーティングを設定することで、使用するアプリの認証機能を実現することが可能となります！

config/routes.rb

  namespace :v1 do
    mount_devise_token_auth_for "User", at: "auth"
  end

また、作成されたUserモデルの:trackableをコメントアウトするか、削除して下さい（ログイン時にエラーが発生します）。

user.rb

class User < ActiveRecord::Base
  # Include default devise modules. Others available are:
  # :confirmable, :lockable, :trackable, :timeoutable and :omniauthable
  devise :database_authenticatable, :registerable,
         :recoverable, :rememberable, :validatable
  include DeviseTokenAuth::Concerns::User
end