ruby-on-rails-api-server

• 1. rbenvのインストール
• 2. gemのversion管理
• 3. rails new
• 4. rails db:create
• 5. rails g(generate) model Hoge
• 6. rails g(generate) controller hoges
• 7. apiサーバ作成

rbenvのインストール

rubyのversion管理を行う rbenv をインストールします．

• まず，後々の比較のためにrubyのversionとインストール先を調べます．

ruby -v
which ruby

• (brewがインストールされている前提で)rbenvをインストールします．この際，ruby-buiidも同時にインストールされます．

brew install rbenv
(brew install ruby-build)

• pathを通したりします．

echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.zshrc
echo 'eval "$(rbenv init -)"' >> ~/.zshrc
source ~/.zshrc

• rubyをインストールします．

rbenv install -L
rbenv install (欲しいversion)
rbenv versions
rbenv global (欲しいversion)
rbenv versions

• rubyのversionとインストール先を調べ，変わっているかどうかを確認します．

ruby -v
which ruby

この際，rubyのインストール先が /Users/{name}/.rbenv/shims/ruby になっていればokです．

• もし変わっていない場合は，pathが通っているかを確認します．

echo $PATH

で表示されるpathの中に，/Users/{name}/.rbenv/shims が入っているかを確認します．

入っていれば．もう一度以下のコマンドを打ち直します．

source ~/.zshrc

gemのversion管理

gemは次のようにインストールすることができます．

gem install (欲しいもの)

しかし，このようにインストールしてしまうと，システムにインストールされ，システムの環境が汚れてしまいます．

そこで，bundlerを用いてプロジェクト毎にgemを管理します．

• Gemfileを作成します．

bundle init

• Gemfileを編集します．

生成されたGemfileは以下のようになっています．

# frozen_string_literal: true

source "https://rubygems.org"

git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }

# gem "rails"

このGemfileに，gem "欲しいもの", "欲しいversion" という文を追加していきます．

例えば，railsの6.0.3.6をインストールしたければ，以下のようにします．

# frozen_string_literal: true

source "https://rubygems.org"

git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }

gem "rails", "6.0.3.6"

• gemをインストールします．

bundle install --path vendor/bundle

• インストールされているか確認します． 以下のコマンドでプロジェクトにインストールされているgemを確認することができます．

bundle exec gem list

一方，システムにインストールされているgemは以下のコマンドで確認することができます．

gem list

以上2つのコマンドを用いて，"rails", "6.0.3.6" が，プロジェクトにはインストールされているが，システムにはインストールされていないことを確認することができます．

rails new

• rails newを行い，railsプロジェクトを作成します．

bundle exec rails new . -B -d mysql --skip-test --api

• configに情報を追加します．

brew info openssl

を叩き，For compilers to find openssl you may need to set:のところを見ます．

そこに書いてある情報を用いて，

bundle config --local build.mysql2 "--with-ldflags=-L/usr/local/opt/openssl@1.1/lib"

のようにします．

• bundle installを行います．

rails db:create

• config/database.yml に適切な情報を入力します．

このファイルにはsecretを載せないようにします．例えば，.envファイルを作成し，dotenv-railsを用いて環境変数から取得するようにします．

• rails db:createを行い，dbを作成します．

bundle exec rails db:create

rails g(generate) model Hoge

• モデルを生成します．

例えば，usersテーブルを生成したい場合は，以下のようにします．

bundle exec rails g model User

このコマンドにより，app/models/user.rbとdb/migrate/{年月日など}.rbが生成されます．

• migrationファイルを変更します．

例えば，usersテーブルに，name, age という2つのカラムを追加したい場合は，以下のようにmigrationファイルを変更します．

class CreateUsers < ActiveRecord::Migration[6.0]
  def change
    create_table :users do |t|
      t.string :name, null: false
      t.integer :age, null: false
      t.timestamps
    end
  end
end

• テーブルを作成します．

bundle exec rails db:migrate

rails g(generate) controller hoges

• コントローラーを生成します．

例えば，users_controllerを生成したい場合は，以下のようにします．

bundle exec rails g controller users

このコマンドにより，app/controllers/users_controller.rbが生成されます．

apiサーバ作成

• config/routes.rbを変更

以下のようにします．

{method} "{path}", to: "{controller}#{action}"

例えば，GET /usersでusers_controller.indexを呼び出したければ，

get "/users", to: "users#index"

とします．

• app/controllersを変更

クラスメソッドとして，actionを追加していきます． jsonを返すには，render json:を使えば良いです．

• app/modelsを変更