Coder Social home page Coder Social logo

how make upload request about rswag HOT 7 CLOSED

rswag avatar rswag commented on May 21, 2024
how make upload request

from rswag.

Comments (7)

pifleo avatar pifleo commented on May 21, 2024 1

Hello,

We had the same problem today and found out it was not implemented. We didn't manage to upload a file with :body.

So here is our patch to get a working file upload with :formData and type: :file:

# rswag-specs/lib/rswag/specs/request_factory.rb

module Rswag
  module Specs
    class RequestFactory

      # ...

      def build_body(example)
        if parameters_in(:formData).present?
          build_form_data(example)
        else
          body_parameter = parameters_in(:body).first
          body_parameter.nil? ? '' : example.send(body_parameter[:name]).to_json
        end
      end

      private

      def build_form_data_value(param, example)
        param[:type] == :file ? example.send(param[:name]) : example.send(param[:name]).to_s
      end

      def build_form_data(example)
        Hash[ parameters_in(:formData).map { |p| [ p[:name], build_form_data_value(p, example) ] } ]
      end

      # ...
    end
  end
end

from rswag.

thg303 avatar thg303 commented on May 21, 2024

mm.. looks like :formData is not implemented

from rswag.

raydog153 avatar raydog153 commented on May 21, 2024

Do you have a typo? for the parameter of type file you have in as 'formDate' and not 'formData'. I'm still trying to figure out how to set header and host for the request.

from rswag.

thg303 avatar thg303 commented on May 21, 2024

@raydog153 oh yeah, that was a typo. but it does not work anyway.
for the header you may use my code, that works for simple queries.

from rswag.

domaindrivendev avatar domaindrivendev commented on May 21, 2024

@thg303 - you're right form data not supported. I think it could be trivial enough - fancy making a PR?

from rswag.

thg303 avatar thg303 commented on May 21, 2024

did it, @domaindrivendev mind to check my PR?

from rswag.

domaindrivendev avatar domaindrivendev commented on May 21, 2024

Should be fixed by #54

from rswag.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.