RailsでのAPIモード（–api）

Railsにおける「APIモード（--api）」は、WebアプリケーションではなくAPI専用のバックエンドを構築するためのモードであり、通常のRailsアプリとは異なる設定や構成が採用されています。以下に詳しく解説します。

---

1. 概要：APIモードとは

Railsのコマンドでアプリケーションを生成する際に --api オプションを付与することで、API専用の軽量なRailsアプリケーションが生成されます。

bash
rails new my_api_app --api

このモードでは、ビューのレンダリング機能やアセットパイプライン（JavaScriptやCSS）は無効化され、JSON形式のリクエスト/レスポンス処理に特化した構成になります。

---

2. 特徴

2.1 ミドルウェアの簡素化

--apiモードでは、Webフロントエンドには不要なミドルウェア（例: Cookieやセッション管理、Flashなど）が除外されます。

ただし、必要であれば個別に追加できます。

ruby
# config/application.rb にて
config.middleware.use ActionDispatch::Cookies

2.2 JSONレスポンスに最適化

デフォルトでコントローラーは ActionController::API を継承しており、ActionController::Base よりも軽量です。ビューを返さず、JSONを直接返す構成になっています。

ruby
class Api::V1::UsersController < ActionController::API
  def index
    users = User.all
    render json: users
  end
end

2.3 アセットパイプラインの無効化

APIモードでは、app/assets ディレクトリは作成されず、Sprocketsなどのアセット管理機構も無効化されています。これはAPIにHTMLやCSSが不要であるためです。

---

3. ディレクトリ構成の違い

---

4. 使用ケース

APIモードは以下のようなユースケースに適しています：

• フロントエンドをReactやVue.jsで構築し、バックエンドをAPI化したい場合

• モバイルアプリ向けのバックエンドAPI

• マイクロサービスの一部としてのRESTful API

---

5. 注意点

• セッション管理やCSRF保護がデフォルトでは無効です。セキュリティ対策が必要なAPI（例：ログイン機能）では、自前でトークンベースの認証を実装する必要があります（例：JWT）。

• HTMLレスポンスを返す処理には適していません。もし途中からHTMLも必要になった場合、通常モードへ切り替えるか、ActionController::Base を使ったコントローラを個別に用意します。

---

6. まとめ

---

必要に応じて、APIモードでも一部のWeb機能（セッション、クッキーなど）を手動で再導入できる柔軟性もあり、現代的なバックエンド開発において非常に有用な構成です。