RailsでPOST経由でJSONB型のカラムにデータを書き込みたい

Question

前提・実現したいこと

RailsでバックエンドAPIを作成しようとしています。
そこでPostgreSQLのJSONB型がどのようなものか試したく、JSONB型カラムを作成しました。

PostmanというサービスからPOSTメソッドを呼び出して、JSONB型カラムに書き込みをしようと試みたのですが、許可されていないパラメータとして処理がされてしまいます。

POSTメソッド経由でJSONB型のデータの更新する方法が知りたいです。

発生している問題・エラーメッセージ

以下の写真のように、PostmanからPOSTすると"artist"のデータがnullになってしまいます。

コンソール上のエラーは以下の通りです。

Started POST "/songs" for ::1 at 2021-09-26 21:47:41 +0900
Processing by SongsController#create as */*
  Parameters: {"song_name"=>"フェイク", "artist"=>{"lyrics_by"=>"Feryquitous", "arranged_by"=>"Feryquitous", "composed_by"=>"Feryquitous"}, "song"=>{"song_name"=>"フェイク", "artist"=>{"lyrics_by"=>"Feryquitous", "arranged_by"=>"Feryquitous", "composed_by"=>"Feryquitous"}}}
Unpermitted parameters: :artist, :song
  TRANSACTION (0.3ms)  BEGIN
  ↳ app/controllers/songs_controller.rb:20:in `create'
  Song Create (2.0ms)  INSERT INTO "songs" ("created_at", "updated_at", "song_name") VALUES ($1, $2, $3) RETURNING "id"  [["created_at", "2021-09-26 12:47:41.811692"], ["updated_at", "2021-09-26 12:47:41.811692"], ["song_name", "フェイク"]]
  ↳ app/controllers/songs_controller.rb:20:in `create'
  TRANSACTION (7.1ms)  COMMIT
  ↳ app/controllers/songs_controller.rb:20:in `create'
Completed 201 Created in 53ms (Views: 2.4ms | ActiveRecord: 16.9ms | Allocations: 4316)

Unpermitted parameters: :artist, :songというエラーになってしまい、artistの中身をnullで処理してしまっているようです。

フェイクというstring型カラムの処理は正常に行われています。

該当のソースコード

songテーブルを以下のコマンドで作成しました。

rails g scaffold song

その後、カラムを追加しました。

rails g migration AddColumnToSong song_name:string artist:jsonb

以下が、該当のコード群です。
コメントアウトにファイル名があります。

# db/migrate/20210926104220_add_column_to_song.rb

class AddColumnToSong < ActiveRecord::Migration[6.1]
  def change
    add_column :songs, :song_name, :string
    add_column :songs, :artist, :jsonb
  end
end

# db/schema.rb

ActiveRecord::Schema.define(version: 2021_09_26_104220) do

  # These are extensions that must be enabled in order to support this database
  enable_extension "plpgsql"

  create_table "songs", force: :cascade do |t|
    t.datetime "created_at", precision: 6, null: false
    t.datetime "updated_at", precision: 6, null: false
    t.string "song_name"
    t.jsonb "artist"
  end
end

# app/models/concerns/song.rb

class Song < ApplicationRecord
end

# app/controllers/concerns/songs_controller.rb

class SongsController < ApplicationController
  before_action :set_song, only: [:show, :update, :destroy]

  # GET /songs
  def index
    @songs = Song.all

    render json: @songs
  end

  # GET /songs/1
  def show
    render json: @song
  end

  # POST /songs
  def create
    @song = Song.new(song_params)

    if @song.save
      render json: @song, status: :created, location: @song
    else
      render json: @song.errors, status: :unprocessable_entity
    end
  end

  # PATCH/PUT /songs/1
  def update
    if @song.update(song_params)
      render json: @song
    else
      render json: @song.errors, status: :unprocessable_entity
    end
  end

  # DELETE /songs/1
  def destroy
    @song.destroy
  end

  private

  # Use callbacks to share common setup or constraints between actions.
  def set_song
    @song = Song.find(params[:id])
  end

  # Only allow a list of trusted parameters through.
  def song_params
    params.permit(
      :song_name,
      :artist
    )
  end
end

試したこと

seeds.rbによるデータの作成はうまくいきました。

# db/seeds.rb

Song.create(
  song_name: "Oxydlate",
  artist: { "composed_by": "Feryquitous", "lyrics_by": "Feryquitous", "arranged_by": "Feryquitous" },
)

$ rails db:seed

この値は、確かにPostmanでGETしたときに確認できました。

やはり、POSTした値は"artist": nullとなってしまっています。

補足情報（FW/ツールのバージョンなど）

繰り返しになって恐縮ですが、JSONB型にPOST経由でデータを書き込む方法が知りたいです。
PostgreSQL、Ruby on Railsともに初学者なため、初歩的なことなのかもしれないのができませんでした。
教えていただければ幸いです。

rails: rake, version 13.0.6
ruby: ruby 3.0.2p107 (2021-07-07 revision 0db68f0233) [x86_64-linux]
node: v14.17.1
yarn: 1.22.11
psql: psql (PostgreSQL) 13.4 (Ubuntu 13.4-1.pgdg20.04+1)

Answer 1

permit は文字列・日付・数値など決められた値しか通さないようになっています。
JSON データを許可したい場合は、以下のように空ハッシュを指定してください。

  def song_params
    params.permit(
      :song_name,
-     :artist
+     artist: {}
    )
  end

--

配列で許可するキーを列挙することも可能です。

  def song_params
    params.permit(
      :song_name,
-     :artist
+     artist: [:lyrics_by, :arranged_by, :composed_by]
    )
  end

--

詳しくは以下のドキュメントをご覧ください。

ActionController::Parameters#permit | Ruby on Rails API

Comments

[yosse95ai]

ありがとうございます。できました。
公式ドキュメントから逃げずに、ちゃんと見なければなりませんね。