How to send the Multipart file and json data to spring boot

Question

I have the POST request api call to accept the json body request parameters and multipart file from client side(postman or java client).

I want to pass both the json data and multipart file in single request.

I have written the code like below.

@RequestMapping(value = "/sendData", method = RequestMethod.POST, consumes = "multipart/form-data")
public ResponseEntity<MailResponse> sendMail(@RequestPart MailRequestWrapper request) throws IOException

But, i could not accomplish it using postman rest client.

I'm using spring boot on server side.

Could anyone suggest me on this question.

Thanks in advance,

stackoverflow.com/questions/16230291/…

Sergey Bulavkin
– Sergey Bulavkin

2018-10-15 13:45:17 +00:00
Commented Oct 15, 2018 at 13:45 — Sergey Bulavkin
– Sergey Bulavkin, Commented Oct 15, 2018 at 13:45
github.com/postmanlabs/postman-app-support/issues/1104

Sergey Bulavkin
– Sergey Bulavkin

2018-10-15 13:52:45 +00:00
Commented Oct 15, 2018 at 13:52 — Sergey Bulavkin
– Sergey Bulavkin, Commented Oct 15, 2018 at 13:52

tsarenkotxt · Accepted Answer · 2018-10-16 11:48:46Z

41

You cat use @RequestParam and Converter for JSON objects
simple example :

@SpringBootApplication
public class ExampleApplication {

    public static void main(String[] args) {
        SpringApplication.run(ExampleApplication.class, args);
    }

    @Data
    public static class User {
        private String name;
        private String lastName;
    }

    @Component
    public static class StringToUserConverter implements Converter<String, User> {

        @Autowired
        private ObjectMapper objectMapper;

        @Override
        @SneakyThrows
        public User convert(String source) {
            return objectMapper.readValue(source, User.class);
        }
    }

    @RestController
    public static class MyController {

        @PostMapping("/upload")
        public String upload(@RequestParam("file") MultipartFile file, 
                             @RequestParam("user") User user) {
            return user + "\n" + file.getOriginalFilename() + "\n" + file.getSize();
        }

    }

}

and postman:

UPDATE apache httpclient 4.5.6 example:

pom.xml dependency:

    <dependency>
        <groupId>org.apache.httpcomponents</groupId>
        <artifactId>httpclient</artifactId>
        <version>4.5.6</version>
    </dependency>
    <dependency>
        <groupId>org.apache.httpcomponents</groupId>
        <artifactId>httpmime</artifactId>
        <version>4.5.6</version>
    </dependency>

   <!--dependency for IO utils-->
    <dependency>
        <groupId>commons-io</groupId>
        <artifactId>commons-io</artifactId>
        <version>2.6</version>
    </dependency>

service will be run after application fully startup, change File path for your file

@Service
public class ApacheHttpClientExample implements ApplicationRunner {

    private final ObjectMapper mapper;

    public ApacheHttpClientExample(ObjectMapper mapper) {
        this.mapper = mapper;
    }

    @Override
    public void run(ApplicationArguments args) {
        try (CloseableHttpClient client = HttpClientBuilder.create().build()) {
            File file = new File("yourFilePath/src/main/resources/foo.json");
            HttpPost httpPost = new HttpPost("http://localhost:8080/upload");

            ExampleApplication.User user = new ExampleApplication.User();
            user.setName("foo");
            user.setLastName("bar");
            StringBody userBody = new StringBody(mapper.writeValueAsString(user), MULTIPART_FORM_DATA);
            FileBody fileBody = new FileBody(file, DEFAULT_BINARY);

            MultipartEntityBuilder entityBuilder = MultipartEntityBuilder.create();
            entityBuilder.addPart("user", userBody);
            entityBuilder.addPart("file", fileBody);
            HttpEntity entity = entityBuilder.build();
            httpPost.setEntity(entity);

            HttpResponse response = client.execute(httpPost);
            HttpEntity responseEntity = response.getEntity();

            // print response
            System.out.println(IOUtils.toString(responseEntity.getContent(), UTF_8));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

}

console output will look like below:

ExampleApplication.User(name=foo, lastName=bar)
foo.json
41

edited Oct 16, 2018 at 11:48

answered Oct 15, 2018 at 21:16

tsarenkotxt

3,5295 gold badges25 silver badges39 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

DIVA Over a year ago

So, after using the converter. I could receive the both multipart file and form data into spring boot api through postman rest client. Thanks for your time and help. Do you have any idea to use this using java application apache http

tsarenkotxt Over a year ago

you are welcome, I updated the answer and added an apache HttpClient example

VIJAYKUMAR SUBRAMANI Over a year ago

Sending json in a request param wouldn't be good idea and implementation.I down vote it.

Raj Pawan Gumdal Over a year ago

How's the data secure if we are using request param to send json data instead of POST body?

jhonatan_yachi · Accepted Answer · 2021-10-28 16:29:35Z

19

You can use both of them.

@RequestPart : This annotation associates a part of a multipart request with the method argument, which is useful for sending complex multi-attribute data as payload, e.g., JSON or XML.

In other words Request Part parse your json string object from request to your class object. On the other hand, Request Param just obtain the string value from your json string value.

For example, using Request Part:

@RestController
@CrossOrigin(origins = "*", methods= {RequestMethod.POST, RequestMethod.GET,
RequestMethod.PUT})
@RequestMapping("/api/api-example")
public class ExampleController{    
@PostMapping("/endpoint-example")
public ResponseEntity<Object> methodExample(
    @RequestPart("test_file") MultipartFile file,
    @RequestPart("test_json") ClassExample class_example) { 
      /* do something */ 
 }
}

and postman would be configured like:

@RequestParam : Another way of sending multipart data is to use @RequestParam. This is especially useful for simple data, which is sent as key/value pairs along with the file, as I said, just key/value. Also is used to get value from query params, I think that is its main goal.

answered Oct 28, 2021 at 16:29

jhonatan_yachi

3812 silver badges4 bronze badges

3 Comments

Akhil Over a year ago

The screenshot of postman helped. I had to add the content-type manually like you mentioned. This does not work in my swagger though. Any idea how to achieve this through swagger? I'm using spring boot.

Anjan Biswas Over a year ago

@jhonatan_yachi, The postman image description may be broken. Could you please upload another one?

Michaël Vreux Jul 2 at 12:54

This was driving my crazy until I notice I hadn't set hte content type for my json, thanks for pointing this out!

nkrivenko · Accepted Answer · 2020-11-15 16:43:25Z

2

I was stuck with this problem for past few hours

So I came across this question.

Summary:
Use @ModelAttribute instead of @RequestBody. @ModelAttriute will work just like other normal(without multipart property in entity) Entity mapping.

edited Nov 15, 2020 at 16:43

nkrivenko

1,3113 gold badges14 silver badges23 bronze badges

answered Nov 15, 2020 at 13:57

Vaibhav Dodiya

213 bronze badges

Comments

Dharman · Accepted Answer · 2020-11-15 15:03:35Z

1

You have two options -

Send a MultipartFile along with json data

public void uploadFile(@RequestParam("identifier") String identifier, @RequestParam("file") MultipartFile file){
}

OR

Send Json data inside a MultipartFile and then parse Multipart file as mentioned below and thats it.

public void uploadFile(@RequestParam("file") MultipartFile file){
    POJO p = new ObjectMapper().readValue(file.getBytes(), POJO.class);
}

edited Nov 15, 2020 at 15:03

Dharman♦

33.9k27 gold badges106 silver badges157 bronze badges

answered Nov 15, 2019 at 11:15

New Bee

4405 silver badges10 bronze badges

Comments

cane · Accepted Answer · 2025-02-17 13:42:40Z

simply add following spring configuration

 @Configuration
 public class JacksonConfig implements WebMvcConfigurer {

/**
 * This method is needed to allow sending multipart requests. For example, when an item is
 * created together with an image. If this is not set the request will return an exception with:
 * <p>
 * Resolved [org.springframework.web.HttpMediaTypeNotSupportedException: Content-Type
 * 'application/octet-stream' is not supported]
 */
@Override
public void configureMessageConverters(List<HttpMessageConverter<?>> messageConverters) {
    messageConverters.stream()
            .filter(MappingJackson2HttpMessageConverter.class::isInstance)
            .map(MappingJackson2HttpMessageConverter.class::cast)
            .forEach(conv -> {
                List<MediaType> supportedMediaTypes = new ArrayList<>(conv.getSupportedMediaTypes());
                supportedMediaTypes.add(MediaType.APPLICATION_OCTET_STREAM);
                conv.setSupportedMediaTypes(supportedMediaTypes);
            });
}

}

Collectives™ on Stack Overflow

How to send the Multipart file and json data to spring boot

5 Answers 5

4 Comments

3 Comments

Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

5 Answers 5

4 Comments

3 Comments

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related