Rails API 設定

[API 設定方法]

通常のrails newコマンドの末尾に--apiをつけることでAPIモードでアプリを作成することができる。
(APIに必要ない部分をデフォルトで作成しなくなる。)

--apiをつけない場合

config/application.rbのApplicationクラス定義の冒頭に、次を追加します。

config.api_only = true

app/controllers/application_controller.rbの以下のコードを置き換えます。

class ApplicationController < ActionController::Base
end

上を以下に変更します。

class ApplicationController < ActionController::API
end

routing分割方法

rails6.1からroutes.rbのファイルを複数に分けることができるようになった。

• ファイル分割する際のディレクトリ構成

  ├─ routes.rb
  │
  └─ routes/ #ここに分割したroutesファイルを格納
     ├─ api.rb
     └─ admin.rb

• routes.rbの記載を変更

draw(:読み込みたいファイル名)

 Rails.application.routes.draw do

  draw(:api) #別ファイルのルーティングを読み込む
  draw(:admmin) #別ファイルのルーティングを読み込む
end

• routesディレクトリ&外部ファイルの作成

以下のディレクトリ構成になるようにroutesディレクトリと外部ファイルを作成します。

config
  ├─ routes.rb
  │
  └─ routes/ #このディレクトリを作成
      ├─ api.rb    #外部ファイルを作成
      └─ admin.rb  #外部ファイルを作成