Help us understand the problem. What is going on with this article?

【Rails】RailsでAPIを作る`rails new <name> --api` コマンドざっくりまとめ

はじめに

RailsでAPIを作成するために使用する

$ rails new <name> --api

について、通常のrails new何が違うのかざっくりまとめました。

※自分用メモです。:bow_tone1:

環境

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

おわりに

最後まで読んで頂きありがとうございました:bow_tone1:

参考にさせて頂いたサイト(いつもありがとうございます)

Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
Comments
No comments
Sign up for free and join this conversation.
If you already have a Qiita account
Why do not you register as a user and use Qiita more conveniently?
You need to log in to use this function. Qiita can be used more conveniently after logging in.
You seem to be reading articles frequently this month. Qiita can be used more conveniently after logging in.
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
ユーザーは見つかりませんでした