Grape Swagger描述JSON主体

Question

我为大多数POST请求发送JSON请求，并将JSON嵌入到请求主体中。我如何用grape swagger来描述这一点呢？

Answer 1

为params添加描述很简单(我假设这就是您所说的“我如何使用grape swagger描述这件事?")。Ivan向您展示了如何使用Hash或Array创建params块，但是要使用Grape描述它们，您需要在params块的requires或optional中添加一个description参数。

class API::Users < Grape::API
  resource 'user' do
    desc 'Create a new user'
    params do 
      requires :user, type: Hash, desc: 'user object to create' do 
        requires :first_name, type: String, desc: 'First name of user'
        requires :last_name, type: String, desc: 'Last name of user'
      end
    end
    post do 
      # do work here
    end
  end
end

端点之前的desc和发送到requires的散列中的desc键都将由Grape拾取并包含在自动文档中。

Answer 2

您可以使用数组或哈希来描述

params do
 optional :preferences, type: Array do
  requires :key
  requires :value
 end

 requires :name, type: Hash do
  requires :first_name
  requires :last_name
 end
end

数组，当您需要保存has_many对象时。当您只需要保存一个对象时，请使用Hash。

例如：

params do
  requires :post, type: Hash do
    requires :title
    requires :description
    optional :images_attributes, type: Array
  end
end