ChatGPT解决这个技术问题 Extra ChatGPT

How to upload a file and JSON data in Postman?

I am using Spring MVC and this is my method:

/**
* Upload single file using Spring Controller.
*/
@RequestMapping(value = "/uploadFile", method = RequestMethod.POST)
public @ResponseBody ResponseEntity<GenericResponseVO<? extends IServiceVO>> uploadFileHandler(
            @RequestParam("name") String name,
            @RequestParam("file") MultipartFile file,
            HttpServletRequest request,
            HttpServletResponse response) {

    if (!file.isEmpty()) {
        try {
            byte[] bytes = file.getBytes();

            // Creating the directory to store file
            String rootPath = System.getProperty("catalina.home");
            File dir = new File(rootPath + File.separator + "tmpFiles");
            if (!dir.exists()) {
                dir.mkdirs();
            }

            // Create the file on server
            File serverFile = new File(dir.getAbsolutePath() + File.separator + name);
            BufferedOutputStream stream = new BufferedOutputStream(new FileOutputStream(serverFile));
            stream.write(bytes);
            stream.close();

            System.out.println("Server File Location=" + serverFile.getAbsolutePath());

            return null;
        } catch (Exception e) {
            return null;
        }
    }
}

I need to pass the session id in postman and also the file. How can I do that?

AFTER ALL IS SAID AND DONE this fixed my issue add [] to the name of the file upload parameter eg. image[] file[] upload[]
Here is a quick 2 minute video tutorial youtu.be/sFlPa_Vow3w

G
Greg T

In postman, set method type to POST.

Then select Body -> form-data -> Enter your parameter name (file according to your code)

On the right side of the Key field, while hovering your mouse over it, there is a dropdown menu to select between Text/File. Select File, then a "Select Files" button will appear in the Value field.

For rest of "text" based parameters, you can post it like normally you do with postman. Just enter parameter name and select "text" from that right side dropdown menu and enter any value for it, hit send button. Your controller method should get called.


Why POST? What about PUT?
What do you mean by "Doesnt work"? Why dont you show your code for us to debug issue easily?
I get the text part as String always. Why does it not map to my DTO? @PostMapping ( value = "/byImageFile", consumes = { "multipart/form-data" }) public ResponseEntity<?> postMap( @RequestPart ( "imageFile") MultipartFile imageFile, @RequestPart ( "fieldsToExtract") RequestDto requestDto ) Iam not able to send the requesst from postman at all in this case
I found my solution. It won't map to RequestDtoautomatically. I took it as a string, parsed the Json and mapped it to RequestDto explicitly.
This is partly correct. You must also set the content type for each json field to application/json. You can do this by clicking the ellipsis next to the 'Bulk edit' link inside Postman.
C
Chris F Carroll

The Missing Visual Guide

You must first find the nearly-invisible pale-grey-on-white dropdown for File which is the magic key that unlocks the Choose Files button.

After you choose POST, then choose Body->form-data, then find the File dropdown, and then choose 'File', only then will the 'Choose Files' button magically appear:

https://i.stack.imgur.com/GygPZ.png


you are correct in that the UI for this is invisible to the non-initiated. Thank you for the visual version!
what if I have an XML body payload and the attachment?
gce's answer seems to say you can do it easily enought? I'm not sure . You might have to learn how to combine the attachment and the XML into a single document by learning about the multi-part mime format. Which isn't too complicated, you can create a multipart mime body by hand.
Two years later, the UI has not been improved any.
Late 2021 update about the UI and the nearly invisible drowdown: you can only see that dropdown if none of the text inputs of that line currently holds the cursor. So move away with tab key to make it appear...
g
gce

Maybe you could do it this way:

https://i.stack.imgur.com/CcnSb.png


What 6 headers have you set there?
This solution works for me. Didn't pass any headers and it's working fine. Thanks. Passing JSON was the tricky part for me. :)
Ha, clever - changed my endpoint to do that :) A bit ugly but super convenient
Can you explain what you are talking about? @ChrisKoston
@GauravSharma how did you set up JSON with form-data. Can you please share input request?
b
burakozgul

Like this :

https://i.stack.imgur.com/OvBFy.png

Body -> form-data -> select file

You must write "file" instead of "name"

Also you can send JSON data from Body -> raw field. (Just paste JSON string)

https://i.stack.imgur.com/qltDv.png


actually i need to pass some values and file in postman for one service is that possible
Headers? what headers to set?
The question asks for uploading json data as well, which is not covered here in this answer.
The correct way to do this : stackoverflow.com/questions/21329426/…
files + (json)?
F
Farid Chowdhury

https://i.stack.imgur.com/5y67n.jpg

I got confused after seeing all of the answers, I couldn't find any proper screenshot to bring the Content Type column. After some time, I found it by my own. Hope this will help somebody like me.

Here is the steps:

click on red marked area of postman. Now check the green marked option (Content Type). Now change the search content type, in the yellow marked area.

In my case:

invoice_id_ls (key) contains the json data. documents contains the file data. placed_amount contains normal text string.


How does the filename relate to the file to be included in the JSON attached?
Yes, this is the missing part of this quest. Spring doesn't want to treat json text as json until its content-type is set manually.
This solution worked for me, the clearest answer in this post. Normally my request body has several fields, so had to set several key-value paris as application/json in the CONTENT_TYPE column. Leaving the file as auto in that same column.
This is the correct answer for sending files + a json text filed in the form-data post request. Thank you so much!!!
o
otamega

https://i.stack.imgur.com/YTh8M.png

Select [Content Type] from [SHOW COLUMNS] then set content-type of "application/json" to the parameter of json text.


R
Rohit Thakur

Don't give any headers. Put your json data inside a .json file. Select your both files one is your .txt file and other is .json file for your request param keys.


This is a good answer.. This can also be used for use cases where multiple file has to be uploaded along with a json payload in a multi-part payload..
This is the most correct answer if you want to send a File as well as JSON data. Examples showing selecting a file and then the JSON data being passed as a single JSON string value or splitting the values up do not work (possibly depending on the end point but I can't verify this). It is also mentioned here: github.com/postmanlabs/postman-app-support/issues/3331
m
miselking

If somebody wants to send json data in form-data format just need to declare the variables like this

Postman:

https://i.stack.imgur.com/e6d3Q.png

As you see, the description parameter will be in basic json format, result of that:

{ description: { spanish: 'hola', english: 'hello' } }

A
Ankur prajapati

Kindly follow steps from top to bottom as shown in below image.

https://i.stack.imgur.com/lice6.png

At third step you will find dropdown of type selection as shown in below image

https://i.stack.imgur.com/qhFjC.png


could u please help explain or point me to a resource on how to work with these API keys for authenticating apis ? I am using laravel admin for some project and its base code is rather confusing on how to use libraries like passport to generate API tokens. many thanks
you can pass through the Authorization tab of postman. In that Select Type: API Key and after that pass value in the key & value textbox. Once you are done with after this if you pass a parameter through the body it will automatically get authenticated.
c
code-8

Body > binary > Select File

https://i.stack.imgur.com/jyDsF.png


E
EstevaoLuis

https://i.stack.imgur.com/X1Lym.png

If you need like Upload file in multipart using form data and send json data(Dto object) in same POST Request

Get yor JSON object as String in Controller and make it Deserialize by adding this line

ContactDto contactDto  = new ObjectMapper().readValue(yourJSONString, ContactDto.class);

Can you tell me what are the two headers used?
Content-Type : application/json Authorization : bearer (yourTokenString)
Yes it worked. Thanks. I used below code and worked : @PostMapping(value = Constant.API_INITIAL + "/uploadFile") public UploadFileResponse uploadFile(@RequestParam("file") MultipartFile file,String jsonFileVo) { FileUploadVo fileUploadVo = null; try { fileUploadVo = new ObjectMapper().readValue(jsonFileVo, FileUploadVo.class); } catch (Exception e) { e.printStackTrace(); }
you can set the Content-Type for contactDtoString to application/json, you can do this for every key
M
Marcos Dantas

If somebody needed:

body -> form-data

Add field name as array

https://i.stack.imgur.com/AwTNO.png


A
Anand_5050

Use below code in spring rest side :

@PostMapping(value = Constant.API_INITIAL + "/uploadFile")
    public UploadFileResponse uploadFile(@RequestParam("file") MultipartFile file,String jsonFileVo) {
        FileUploadVo fileUploadVo = null;
        try {
            fileUploadVo = new ObjectMapper().readValue(jsonFileVo, FileUploadVo.class);
        } catch (Exception e) {
            e.printStackTrace();
        }

https://i.stack.imgur.com/lpV4c.png


k
kubilay

If you want to make a PUT request, just do everything as a POST request but add _method => PUT to your form-data parameters.


This is what I was looking for. I got confused as to why it worked on POST but not PUT. earlier. Thank you!!
@kubilay this didn't work
v
vinci mojamdar

I needed to pass both: a file and an integer. I did it this way:

needed to pass a file to upload: did it as per Sumit's answer. Request type : POST Body -> form-data under the heading KEY, entered the name of the variable ('file' in my backend code). in the backend: file = request.files['file'] Next to 'file', there's a drop-down box which allows you to choose between 'File' or 'Text'. Chose 'File' and under the heading VALUE, 'Select files' appeared. Clicked on this which opened a window to select the file.

2. needed to pass an integer:

went to:

Params

entered variable name (e.g.: id) under KEY and its value (e.g.: 1) under VALUE

in the backend:

id = request.args.get('id')

Worked!


It was the file = request.files['file']for me. Thanks, saved my day
A
Ahsan Farooq

https://i.stack.imgur.com/yqJGU.png


H
Hritcu Andrei

For each form data key you can set Content-Type, there is a postman button on the right to add the Content-Type column, and you don't have to parse a json from a string inside your Controller.


R
Rizka Khoirotunnisa

first, set post in method and fill link API

Then select Body -> form-data -> Enter your parameter name (file according to your code)


As it’s currently written, your answer is unclear. Please edit to add additional details that will help others understand how this addresses the question asked. You can find more information on how to write good answers in the help center.
S
Sandesh Jain

If you are using cookies to keep session, you can use interceptor to share cookies from browser to postman.

Also to upload a file you can use form-data tab under body tab on postman, In which you can provide data in key-value format and for each key you can select the type of value text/file. when you select file type option appeared to upload the file.


For what you are getting 500. can you please share some more details
T
Tom McDonough

If you want the Id and File in one object you can add your request object to a method as standard and then within Postman set the Body to form-data and prefix your keys with your request object name. e.g. request.SessionId and request.File.


j
jitendra singh

The steps of uploading a file through postman along with passing some input data is very well discussed in below blog along with the screenshot. In this blog, the api code is written in node js. You can go through it once to have more clarity.

https://jksnu.blogspot.com/2021/09/how-to-create-post-request-with.html


K
Kai-Sheng Yang

You can send both Image and optional/mandatory parameters.

In postman, there is Params tab.

https://i.ibb.co/xDQ0KZL/ParamTab.jpg


A
Anshu Kumar

At Back-end part

Rest service in Controller will have mixed @RequestPart and MultipartFile to serve such Multipart + JSON request.

@RequestMapping(value = "/executesampleservice", method = RequestMethod.POST,
consumes = {"multipart/form-data"})

@ResponseBody
public boolean yourEndpointMethod(
    @RequestPart("properties") @Valid ConnectionProperties properties,
    @RequestPart("file") @Valid @NotNull @NotBlank MultipartFile file) {
return projectService.executeSampleService(properties, file);
}

At front-end :

formData = new FormData();

formData.append("file", document.forms[formName].file.files[0]);
formData.append('properties', new Blob([JSON.stringify({
            "name": "root",
            "password": "root"                    
        })], {
            type: "application/json"
        }));

See in the image (POSTMAN request):

Click to view Postman request in form data for both file and json


k
kishan maharana

To send image along with json data in postman you just have to follow the below steps .

Make your method to post in postman

go to the body section and click on form-data

provide your field name select file from the dropdown list as shown below

you can also provide your other fields .

now just write your image storing code in your controller as shown below .

https://i.stack.imgur.com/k3m0y.png

my controller :

public function sendImage(Request $request)
{
    $image=new ImgUpload;  
    if($request->hasfile('image'))  
    {  
        $file=$request->file('image');  
        $extension=$file->getClientOriginalExtension();  
        $filename=time().'.'.$extension;  
        $file->move('public/upload/userimg/',$filename);  
        $image->image=$filename;  
    }  
    else  
    {  
        return $request;  
        $image->image='';  
    }  
    $image->save();
    return response()->json(['response'=>['code'=>'200','message'=>'image uploaded successfull']]);
}

That's it hope it will help you