ruby-on-rails – 葡萄：葡萄实体需要的参数

module Smart
  module Version1
    class App < BaseApi

      resource :app do

        # POST /app
        desc 'Creates a new app' do
          detail 'It is used to re gister a new app on the server and get the app_id'
          params  Entities::OSEntity.documentation
          success Entities::AppEntity
          failure [[401,'Unauthorized',Entities::ErrorEntity]]
          named 'My named route'
        end
        post do
          app = ::App.create params
          present app,with: Entities::AppEntity
        end
      end
    end
  end
end

module Smart
  module Entities
    class OSEntity < Grape::Entity

      expose :os,documentation: { type: String,desc: 'Operative system name',values: App::OS_LIST,required: true }

    end
  end
end

module Smart
  module Entities
    class AppEntity < OSEntity

      expose :id,documentation: { type: 'integer',desc: 'Id of the created app',required: true }
      expose :customer_id,desc: 'Id of the customer',required: true }

    end
  end
end

经过一些工作,我能够让葡萄工作,因为我觉得它应该有效.因为我不想重复验证和文档的代码.你只需要将它添加到初始化器(当然,如果你在rails中).我也能够支持嵌套关联.正如您所看到的,API代码看起来如此简单,并且swagger看起来很完美.
以下是API和所有需要的实体：

应用程序/ API /智能/实体/ characteristics_params_entity.rb

module Smart
  module Entities
    class CharacteristicsParamsEntity < Grape::Entity

      root :characteristics,:characteristic
      expose :id,documentation: { type: Integer,desc: 'Id of the characteristic' }

    end
  end
end

应用程序/ API /智能/实体/ characterisitcs_entity.rb

module Smart
  module Entities
    class CharacteristicsEntity < CharacteristicsParamsEntity

      expose :id,desc: 'Id of the characteristic' }
      expose :name,desc: 'Name of the characteristic' }
      expose :description,desc: 'Description of the characteristic' }
      expose :characteristic_type,desc: 'Type of the characteristic' }
      expose :updated_at,documentation: { type: Date,desc: 'Last updated time of the characteristic' }

    end
  end
end

应用程序/ API /智能/实体/ apps_params_entity.rb

module Smart
  module Entities
    class AppsParamsEntity < Grape::Entity

      expose :os,required: true }
      expose :characteristic_ids,using: CharacteristicsParamsEntity,documentation: { type: CharacteristicsParamsEntity,desc: 'List of characteristic_id that the customer has',is_array: true }


    end
  end
end

应用程序/ API /智能/实体/ apps_entity.rb

module Smart
  module Entities
    class AppsEntity < AppsParamsEntity

      unexpose :characteristic_ids
      expose :id,required: true }
      expose :characteristics,using: CharacteristicsEntity,documentation: { is_array: true,desc: 'List of characteristics that the customer has' }

    end
  end
end

应用程序/ API /智能/ VERSION1 / apps.rb

module Smart
  module Version1
    class Apps < Version1::BaseAPI

    resource :apps do

        # POST /apps
        desc 'Creates a new app' do
          detail 'It is used to register a new app on the server and get the app_id'
          params Entities::AppsParamsEntity.documentation
          success Entities::AppsEntity
          failure [[400,'Bad Request',Entities::ErrorEntity]]
          named 'create app'
        end
        post do
          app = ::App.create! params
          present app,with: Entities::AppsEntity
        end

      end

    end
  end
end

这就是使魔术成功的代码：

配置/初始化/ grape_extensions.rb

class Evaluator
  def initialize(instance)
    @instance = instance
  end

  def params parameters
    evaluator = self
    @instance.normal_params do
      evaluator.list_parameters(parameters,self)
    end
  end

  def method_missing(name,*args,&block)
  end

  def list_parameters(parameters,grape)
    evaluator = self
    parameters.each do |name,description|
      description_filtered = description.reject { |k| [:required,:is_array].include?(k) }
      if description.present? && description[:required]
        if description[:type] < Grape::Entity
          grape.requires name,description_filtered.merge(type: Array) do
            evaluator.list_parameters description[:type].documentation,self
          end
        else
          grape.requires name,description_filtered
        end
      else
        if description[:type] < Grape::Entity
          grape.optional name,self
          end
        else
          grape.optional name,description_filtered
        end
      end
    end
  end
end

module GrapeExtension
  def desc name,options = {},&block
    Evaluator.new(self).instance_eval &block if block
    super name,options do
      def params *args
      end

      instance_eval &block if block
    end
  end
end

class Grape::API
  class << self
    prepend GrapeExtension
  end
end

这是示例的结果：