ruby-on-rails - 在葡萄 api 中添加了根，但未包含在响应中

Question

我正在关注这篇文章以了解如何使用葡萄 gem编写 api 。但在响应中，我没有得到根密钥。这是我的目录结构，

app
 |––controllers
       |––api
           |––base.rb
           |––v1
               |––base.rb
               |––graduates.rb

在 app/controllers/api/v1/graduates.rb 中：

module API
  module V1
    class Graduates < Grape::API
      include API::V1::Defaults
  resource :graduates do
    desc "Return all graduates"
    get "", root: :graduates do
      Graduate.all
    end

    desc "Return a graduate"
    params do
      requires :id, type: String, desc: "ID of the 
        graduate"
    end
    get ":id", root: "graduate" do
      Graduate.where(id: permitted_params[:id]).first!
    end
  end
end

结束结束

在 app/controllers/api/v1/defaults.rb

module API
  module V1
    module Defaults
      extend ActiveSupport::Concern
  included do
    prefix "api"
    version "v1", using: :path
    default_format :json
    format :json
    formatter :json, 
         Grape::Formatter::ActiveModelSerializers

    helpers do
      def permitted_params
        @permitted_params ||= declared(params, 
           include_missing: false)
      end

      def logger
        Rails.logger
      end
    end

    rescue_from ActiveRecord::RecordNotFound do |e|
      error_response(message: e.message, status: 404)
    end

    rescue_from ActiveRecord::RecordInvalid do |e|
      error_response(message: e.message, status: 422)
    end
  end
end

结束结束

我使用grape-active_model_serializersgem 进行如下序列化，在 app/serializers/graduate_serializer.rb

class GraduateSerializer < ActiveModel::Serializer
  attributes :id, :name
end

我得到以下输出。[{"id":1,"name":"aaaa"},{"id":2,"name":"bbbb"},{"id":3,"name":"cccc"},{"id":4,"name":"dddd"}]

但正如我 get "", root: :graduates do在app/controllers/api/v1/graduates.rb文件中添加的那样，我期待以下输出，

{"graduates": [{"id":1,"name":"aaaa"},{"id":2,"name":"bbbb"},{"id":3,"name":"cccc"},{"id":4,"name":"dddd"}]}

我错过了什么。为什么graduates不添加为root。帮我解决这个问题。

标签： ruby-on-railsrubyapigrapegrape-api

Answer 1

肮脏的修复：使用app/controllers/api/v1/graduates.rb

get "" do
    { graduates: Graduate.all }
end

或者你可以删除 gem grape-active_model_serializers，删除 class ，从GraduateSerializer中删除行，并将 gem grape-entity添加到 Gemfile，安装它，添加代码到：formatter :json, Grape::Formatter::ActiveModelSerializersdefaults.rbapp/app/entities/graduate_entity.rb

class GraduateEntity < Grape::Entity
  root 'graduates', 'graduate'

  expose :id
  expose :name
end

更改代码app/app/controllers/api/v1/graduates.rb：

get "" do
  present Graduate.all, with: GraduateEntity
end