модуль ActionController::ParamsWrapper
Оборачивает параметр хэш в вложенный хэш. Это позволит клиентам отправлять запросы без необходимости указывать корневые элементы.
Эта функциональность включена по умолчанию для JSON и может быть настраиваема с помощью массива форматов:
class ApplicationController < ActionController::Base wrap_parameters format: [:json, :xml] end
Вы также можете включить её для конкретного контроллера:
class UsersController < ApplicationController wrap_parameters format: [:json, :xml, :url_encoded_form, :multipart_form] end
Если вы включите ParamsWrapper для :json формата, вместо того, чтобы отправлять параметры JSON так:
{"user": {"name": "Konata"}}
Вы можете отправлять параметры так:
{"name": "Konata"}
И они будут обернуты во вложенный хэш с именем ключа, соответствующим имени контроллера. Например, если вы отправляете POST-запрос на UsersController, ваш новый params хэш будет выглядеть так:
{"name" => "Konata", "user" => {"name" => "Konata"}}
Вы также можете указать ключ, в который должны быть обернуты параметры, а также список атрибутов, которые он должен обернуть, используя либо :include или :exclude опции, например:
class UsersController < ApplicationController wrap_parameters :person, include: [:username, :password] end
В моделях Active Record без установленных опций :include или :exclude будут обернуты только параметры, возвращаемые методом класса attribute_names.
Если вы собираетесь передать параметры объекту ActiveModel (например, User.new(params[:user])), вы можете рассмотреть возможность передачи класса модели в метод вместо этого. ParamsWrapper попытается определить список имён атрибутов из модели и обернуть только эти атрибуты:
class UsersController < ApplicationController wrap_parameters Person end
Вы все равно можете передать :include и :exclude для установки списка атрибутов, которые вы хотите обернуть.
По умолчанию, если вы не укажете ключ, в который будут обернуты параметры, ParamsWrapper попытается определить, есть ли связанная с ним модель или нет. Например, этот контроллер:
class Admin::UsersController < ApplicationController end
попытается проверить, существует ли модель Admin::User или User, и использовать её для определения ключа обертки соответственно. Если обе модели не существуют, он будет использовать user в качестве ключа.
Чтобы отключить эту функциональность для контроллера:
class UsersController < ApplicationController wrap_parameters false end
Константы
- EXCLUDE_PARAMETERS
© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.