rails6 APIを実装する

2021.01.16
rails
Rails6

rails6で、APIを実装するまでの手順を記述してます。APIを確認するために「Talend API Tester」を使用してます。railsのバージョンは6.1.0です。

1. 環境
2. テーブルとモデル作成
3. ルーティング設定
4. コントローラー作成
5. APIデータ作成
6. jbuilderテンプレート作成
7. API確認

環境

OS ubuntu20.10
ruby 2.7.2
rails 6.1.0
Postgresql 13.1 (dockerで構築)

docker composeを使ってPostgreSQLを構築する

テーブルとモデル作成

テーブル「customers」を作成します。

rails g model Customer name:string email:string

1	rails g model Customer name:string email:string

マイグレーションを実行します。

rails db:migrate

1	rails db:migrate

テーブル「customers」

ルーティング設定

「config」ディレクトリ配下にある「routes.rb」に以下を追加します。

Rails.application.routes.draw do
  root "top#index"

　# 追加
  namespace :api, format: "json" do
    resources :customers, only: [:index, :create, :update]
  end
end

Rails.application.routes.draw do

root "top#index"

　# 追加

namespace :api, format: "json" do

resources :customers, only: [:index, :create, :update]

end

コントローラー作成

「app/controllers」に「api」ディレクトリを作成して「customers_controller.rb」を作成します。

class Api::CustomersController < ApplicationController
  skip_before_action :verify_authenticity_token

  def index
    @customers = Customer.all
  end

  def create
    @customer = Customer.new(customer_params)

    if @customer.save
      render :show, status: :created
    else
      render json: @customer.errors, status: :unprocessable_entity
    end
  end

  def update
    @customer = Customer.find(params[:id])
    if @customer.update(customer_params)
      render :show, status: :ok
    else
      render json: @customer.errors, status: :unprocessable_entity
    end
  end

  private

  def customer_params
    params.fetch(:customer, {}).permit(
      :name, :email
    )
  end
end

class Api::CustomersController < ApplicationController

skip_before_action :verify_authenticity_token

def index

@customers = Customer.all

end

def create

@customer = Customer.new(customer_params)

if @customer.save

render :show, status: :created

else

render json: @customer.errors, status: :unprocessable_entity

end

def update

@customer = Customer.find(params[:id])

if @customer.update(customer_params)

render :show, status: :ok

else

render json: @customer.errors, status: :unprocessable_entity

end

private

def customer_params

params.fetch(:customer, {}).permit(

:name, :email

)

end

APIデータ作成

Fakerを使って、ダミーデータを作成してます。

Fakerを使ってダミーデータを作成する

jbuilderテンプレート作成

「app/views/api/customers」ディレクト配下に、「index.json.jbuilder」

json.set! :customers do
  json.array! @customers do |customer|
    json.extract! customer, :id, :name, :email, :created_at, :updated_at
  end
end

json.set! :customers do

json.array! @customers do |customer|

json.extract! customer, :id, :name, :email, :created_at, :updated_at

end

「show.json.jbuilder」を作成します。

json.set! :customer do
  json.extract! @customer, :id, :name, :email, :created_at, :updated_at
end

json.set! :customer do

json.extract! @customer, :id, :name, :email, :created_at, :updated_at

end

API確認

Talend API Testerを使用して確認してます。

get

post

curlコマンドでも確認できます。

get

curl localhost:3000/api/customers

1	curl localhost:3000/api/customers

post

curl -X POST localhost:3000/api/customers -d 'customer[name]=hoge&customer[email]=test@test.com'

1	curl -X POST localhost:3000/api/customers -d 'customer[name]=hoge&customer[email]=test@test.com'

自分が一番利用するpostmanを使用した場合は、以下となります。

get

post

rails6 APIを実装する

環境

テーブルとモデル作成

ルーティング設定

コントローラー作成

APIデータ作成

jbuilderテンプレート作成

API確認

Alpine.jsを使ってhoverで表示されるツールチップを作成する 2021.01.16

javascript ノードを移動させる 2021.01.16