API設計【Userモデル】

[Fumiya-Matsumoto]

概要

UserモデルのAPIを設計する

• Web API：The Good Partsを参考に「美しい設計のAPI」を作る

  目的

• 美しいWeb APIには以下の利点がある
  • 使いやすい
  • 変更しやすい
  • 頑丈である
  • 恥ずかしくない

目的達成のために

• 以下の原則に従う
  • 仕様が決まっているものに関しては仕様に従う
  • 仕様が存在していないものに関しては、デファクトスタンダードに従う

参考

• [Web API:The Good Parts]()
• RESTful APIのURI設計(エンドポイント設計)
• REST API設計者のための有名APIのURL例
• 翻訳: WebAPI 設計のベストプラクティス

[Fumiya-Matsumoto]

Userに関するAPIエンドポイントを修正する

現状①

問題

新規登録はdeviseを使っているため、余計なエンドポイントができてしまっている。	メソッド名	エンドポイント	アクション
GET	/v1/users(.:format)	v1/users#index
POST	/v1/users(.:format)	v1/users#create
GET	/v1/users/:id(.:format)	v1/users#show
PATCH	/v1/users/:id(.:format)	v1/users#update
PUT	/v1/users/:id(.:format)	v1/users#update
DELETE	/v1/users/:id(.:format)	v1/users#destroy

解決案

• いらないエンドポイントは削除する
• ユーザーの情報を取得する

[Fumiya-Matsumoto]

devise_token_authで新規ユーザー登録、ユーザー情報編集においてparametersを追加する方法

1. registrations_controllerに追記する

app/controllers/v1/auth/registrations_controller.rbを作る。 これによって、registrations_controllerをオーバーライドする。

class V1::Auth::RegistrationsController < DeviseTokenAuth::RegistrationsController
    private
    #ユーザー登録時に使用
    def sign_up_params
        params.permit(:name, :email, :password, :password_confirmation)
    end
    #ユーザー更新時に使用
    def account_update_params
        params.permit(:name, :email)
    end
end

2. routes.rbを更新する

ルーティングを更新する。

Rails.application.routes.draw do
  namespace :v1 do
    resources :posts
    mount_devise_token_auth_for 'User', at: 'auth', controllers: {
      registrations: 'v1/auth/registrations'
    }
  end
end

参考

• 【Rails】devise_token_authで新規ユーザー登録時にUnpermitted parameters: が出たときの対処法
• 【React】＋【RailsAPI】 アプリ [3] ユーザー認証（devise/devise_token_auth/redux-token-auth）_前編

[Fumiya-Matsumoto]

いらないエンドポイントを削除

routes.rbを編集して、indexアクション、showアクションに絞った。 ログイン中でなければアクセスできないように後ほど編集する。