はじめに
RailsでAPIを作成するために使用する
$ rails new <name> --api
について、通常のrails newと何が違うのかざっくりまとめました。
※自分用メモです。
環境
OS: macOS Catalina 10.15.1
Ruby: 2.6.5
Rails: 6.0.2.1
作成コマンド
$ rails new my_api --api
--apiを付けることで、APIに必要なファイルだけがインストールされる。
通常のrails newとの違い
- ApplicationControllerが継承するのはActionController::APIになる。（※通常はActionController::Base)
- ブラウザ向けアプリケーションでで使われるミドルウェア（cookiesのサポートなど）
- ブラウザ向けアプリケーションでしか使われないモジュール
- ビュー、ヘルパー、アセットは生成されないようにジェネレーターが設定される
- 例：
rails g controller home indexでビューが生成されない
- 例：
-
rails g scaffoldすると、jsonを返すようにアクションが設定される
【例】
def show
render json: @record
end
おわりに
最後まで読んで頂きありがとうございました