модуль ActionController::ParamsWrapper
Оборачивает хэш параметров в вложенный хэш. Это позволит клиентам отправлять запросы без необходимости указывать корневые элементы.
Эта функциональность включена в config/initializers/wrap_parameters.rb и может быть настраиваема.
Вы также можете включить её для конкретного контроллера, установив массив форматов на непустой массив:
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 в качестве ключа.
Константы
- EXCLUDE_PARAMETERS
Публичные методы экземпляра
# File actionpack/lib/action_controller/metal/params_wrapper.rb, line 243 def process_action(*args) _perform_parameter_wrapping if _wrapper_enabled? super end
Выполняет оборачивание параметров по запросу. Вызывается автоматически стеком вызовов мета-метода.
© 2004–2019 David Heinemeier Hansson
Licensed under the MIT License.