如何构建Rails API控制器处理多部分请求的参数方法

问题根源 #

使用multipart/form-data发送请求时，若将JSON格式的参数嵌套在dream_destination字段中，Rails不会自动解析该JSON字符串为Hash，导致params[:dream_destination]为字符串类型，调用permit方法触发undefined method 'permit' for String错误。同时原参数方法未允许image字段，无法接收上传的图片文件。

解决方案 #

1. 修正参数强转逻辑 #

方案A：解析嵌套的JSON字符串

若坚持将JSON放在dream_destination字段中，需手动解析字符串为Hash后再做参数过滤，同时添加image字段的允许：

def dream_destination_params
  # 解析JSON字符串为Ruby Hash
  dream_destination_data = JSON.parse(params[:dream_destination])
  # 转换为ActionController::Parameters并合并图片参数
  ActionController::Parameters.new(dream_destination_data)
    .permit(:name, :description)
    .merge(image: params[:image])
end

方案B：直接使用表单字段（推荐）

更符合multipart请求的常规写法：将name、description作为独立的表单字段，无需嵌套JSON，直接调整参数方法：

def dream_destination_params
  params.permit(:name, :description, :image)
end

2. 正确构造PAW测试请求 #

对应方案A的请求构造

• 请求方法：POST，目标URL：/api/v1/dream_destinations
• 请求头：无需手动设置Content-Type，PAW会自动处理multipart/form-data
• 表单字段：
  • 添加dream_destination字段，值为JSON字符串（例如{"name":"Example city","description":"It works now!"}）
  • 添加image字段，选择本地图片文件

对应方案B的请求构造

• 表单字段分别添加name、description（填入文本值）和image（选择图片文件），无需嵌套JSON。

3. 优化返回JSON格式（可选） #

默认render json:不会包含图片URL，可在模型中重写as_json方法统一返回结构：

class Api::V1::DreamDestination < ApplicationRecord
  include Rails.application.routes.url_helpers
  has_one_attached :image
  belongs_to :user
  validates :image, presence: true

  def get_image_url
    url_for(self.image)
  end

  def as_json(options = {})
    super(options).merge(image_url: get_image_url)
  end
end

内容的提问来源于stack exchange，提问作者Raphtml