尝试在 Grape API 中解析请求正文

Question

所以我有一个 API，其中一个入口点看起来像：

module SomeModule
  module SomeOtherModule
    class Users < SomeModule::SomeOtherModule::Base
      helpers do
        params :user do
          requires :user, type: Hash do
            requires :device_id, type: String, desc: "Device ID"
          end
        end
      end

      desc "Some description"
      params do
        use :user
      end

      put "/", route_name: :v1_put_user_path do
        ...
      end
    end
  end
end

SomeModule::SomeOtherModule::Base 继承自 Grape::API

我的客户正在发送正文中的参数 - 看起来像：

{"user[device_id]":"xyz"}

由于这就像一个字符串，我无法识别它们。因此返回：

{"error":"user is missing"}

这意味着在我的服务器上我得到：

{"user[device_id]"=>"00999877",
  "route_info"=>
   ...

当我期待看到时：

{"user"=>{"device_id"=>"00999877"},
  "route_info"=>
  ...

关于我应该如何定义我的参数的任何想法？...或者也许有人偶然发现了这个问题并可以提供一些解决方案

Answer 1

你必须像这样定义你的 params 块：

module SomeModule
    module SomeOtherModule
        class Users < SomeModule::SomeOtherModule::Base
            params do
                group :user, type: Hash do
                    requires :device_id, type: String, desc: "Device ID"
                end
            end
            put "/", route_name: :v1_put_user_path do
                ...
            end
        end
    end
end

更新

解释解决方案...

如果您的客户端正在发送类似于下面代码的 JSON，那么您必须定义一个组块并将类型参数定义为 Hash。当您的客户端发送像 user[device_id] 这样的“表单字段”时，同样的规则也适用。

{ user: { device_id: 1 } }

更新 2

我刚刚注意到您的客户端向您的服务发送了不正确的 JSON。这个 JSON 不应该是……

{"user[device_id]":"xyz"} 

...因为这不是您的 API 所期望的。相反，它应该发送

{ user: { device_id: "xyz" } }.