如何使用驼峰键名从 Rails 返回 JSON

Question

我正在构建一个带有 Rails 后端的 JS 应用程序，为了不混淆蛇和骆驼案例，我想通过从服务器返回骆驼案例键名来规范这一切。所以user.last_name 从 API 返回时会返回 user.lastName。

我如何实现这一目标？谢谢！

编辑：添加控制器代码

class Api::V1::UsersController < API::V1::BaseController
  # authorize_resource
  respond_to :json, only: [:index]
  def sky
      @user = User.find_by_id(params[:user_id])

      if @user
          obj =  {
              sky: {
                  sectors: @user.sectors,
                  slots: @user.slots
              }
          }

          render json: obj
      else
          raise "Unable to get Sky"
      end
  end
end

Answer 1

我的做法是使用 ActiveModelSerializer 和 json_api 适配器：

在您的 Gemfile 中，添加：

gem 'active_model_serializers'

创建一个新文件/config/initializers/ams.rb，其中包含：

ActiveModelSerializers.config.adapter = :json_api
ActiveModelSerializers.config.key_transform = :camel_lower

您的控制器操作应如下所示：

class ApiController < ApplicationController
  def sky
    @user = User.find_by_id(params[:user_id])

    if @user
      render json: @user, serializer: UserSkySerializer
    else
      raise "Unable to get Sky"
    end
  end
end

现在您需要创建一个序列化程序。首先，新建一个目录app/serializers/。

接下来，创建一个新的序列化程序app/serializers/user_sky_serializer.rb，包含：

class UserSkySerializer < ActiveModel::Serializer
  attributes :sectors, :slots
end

结果将类似于您在 obj 哈希中描述的内容，但所有属性键都将使用 jsonapi 标准以驼峰形式呈现。

Answer 2

另一个选项是使用olive_branch gem。如this post 中所述，您只需：

1. 添加此宝石
2. 在application.rb 中添加config.middleware.use OliveBranch::Middleware。

然后，将此标头添加到来自客户端应用程序的请求中：

'X-Key-Inflection': 'camel'

如果您使用像 axios 这样的库，您可以将此标头与其他标头一起添加到常量中：

const HEADERS = {
  ...
  'X-Key-Inflection': 'camel'
}

const request = axios.post(url, param, HEADERS)

这样你就不需要在服务器端手动deep_transform 键。即使是深度嵌套的 json 键也会被骆驼化。此类请求的示例响应：

[
  {
    "id": 1,
    "firstName": "Foo",
    "lastName": "Bar",
    "createdAt": ...,
    "updatedAt": ...,
    ...
    "cabinAssignments": [
      {
        "id": 1,
        "cabinKeeperId": 1,
        "userId": 1,
        "houseId": 1,
        ...
      }
    ]
  }
]

Answer 3

你没有提到你的 Rails 版本，所以对于寻找这个的其他人，我会提到在 Rails 5 中，答案是使用来自ActiveSupport::Inflector 的#camelize。就我而言，我不得不在ActiveRecord 模型（下面的t）上以链的形式调用它：

  def index
    trucks = AvailableTruck.all.map do |t|
      t.as_json(only: AvailableTruck.exposed)
       .deep_transform_keys(&:camelize).deep_transform_values(&:upcase)
    end
    render json: trucks
  end

#deep_transform_keys 可能需要也可能不需要，具体取决于您的应用程序。

Answer 4

您可以使用 ruby​​ 的 method_missing 方法来实现。

创建一个类似concerns/method_missing_extension.rb 的文件并将以下代码放入其中。

module MethodMissingExtension
  def method_missing(method_name, args = {})
    if self.class.column_names.include? method_name.to_s.underscore
      send method_name.to_s.underscore.to_sym
    else
      super
    end
  end
end

在每个模型中包含这个模块，例如include MethodMissingExtension。

现在，无论您何时执行user.firstName，都会返回user.first_name。