Question

我正在使用Swagger 2.0，我有一个问题是发送多个帖子参数。我有一个招摇错误/updateDatas: post: summary: Upadate datas description: | Update datas consumes: - multipart/form-data produces: - application/json parameters: - name: firstFileName in: formData description: First file name. required: true type: string - name: secondFileName in: formData description: Second file name. required: true type: string - name: datas in: body description: Json object informations. required: true schema: $ref: '#/definitions/Datas' - name: firstFile in: formData description: First file .jpg required: true type: file - name: clientFile in: formData description: Second file .jpg required: true type: file tags: - Application responses: '200': description: Uploaded schema: $ref: '#/definitions/Upload' '401': description: Unauthorized Bad Token，我不知道如何解决它。在我的定义中，我有一个body参数，这个参数需要一个JSON格式，但是我还有其他参数，比如要上传的文件和文件名。

如何发送body和formData参数呢？

以下是Web服务定义：

class Checkout < Reform::Form
  extend ::ActiveModel::Callbacks
  #...
  property :billing_address, populate_if_empty: Address, form: BillingAddress 
  property :shipping_address, populate_if_empty: Address, form: ShippingAddress 
  #...
end

class BillingAddress < Reform::Form
  extend ::ActiveModel::Callbacks
  include AddressModule
end

class ShippingAddress < Reform::Form
  extend ::ActiveModel::Callbacks
  include AddressModule
end

module AddressModule
  include Reform::Form::Module

  property :firstname
  property :lastname
  property :address1
  property :address2
  property :phone
  property :city
  property :zipcode
  property :country_id
  property :billing_address_for_id
  property :shipping_address_for_id

  validates :firstname,
            :lastname,
            :address1,
            :phone,
            :city,
            :zipcode,
            :country_id,
            presence: true

  # provided by phony_rails gem
  # validates phone number to be correct and plausible 
  # without country accordance
  validates :phone, phony_plausible: { ignore_record_country_code: true }

  # provided by validates_zipcode gem
  # validates zipcode to be correct due to country alpha2 code
  validates :zipcode, zipcode: { country_code: :country_code }
end

Answer 1

根据 swagger 规范see，type:body和type:formData不能同时存在于同一操作中。

Answer 2

解决此问题的一种方法是将“datas”设置为带有“file”类型的表单参数。这是一个例子：

  parameters:
    - name: petId
      in: path
      description: ID of pet to update
      required: true
      type: integer
      format: int64
    - name: additionalMetadata
      in: formData
      description: Additional data to pass to server
      required: false
      type: string
    - name: file
      in: formData
      description: file to upload
      required: false
      type: file

参考：https://github.com/swagger-api/swagger-codegen/blob/master/modules/swagger-codegen/src/test/resources/2_0/petstore.yaml#L257

更新：正文参数和表单参数不能共存：https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#parameterObject

Body - 附加到HTTP请求的有效负载。由于只能有一个有效负载，因此只能有一个主体参数。 body参数的名称对参数本身没有影响，仅用于文档目的。由于Form参数也在有效负载中，因此对于相同的操作，body和form参数不能一起存在。

Swagger发送body和formData参数

2 个答案: