GetMapping to produce CSV file using Spring Boot

Question

I'm writing a spring rest method to get details from database and set it in a response POJO and then return it. Currently I need to produce this response in CSV instead of default json when the URL is hit using POSTMAN or RC like a downloadable CSV file with data. I googled many sites but am not sure of few logics.

Do we need to write business logic to convert pojo class values to csv format or does spring has any conversion mechanism ?
Produces = "text/csv" is being mentioned on many places, does this convert response properly ?

Currently I haven't written any code for CSV conversion.

@GetMapping("/batch/export" , produces="text/csv")
public ResponseEntity<ApplicationResponse> getBatchDetails(
        HttpServletRequest request) {

    ApplicationRequest appRequest = ApplicationServiceMapper.mapRequestFromHttpRequest(request);
    ApplicationResponse response = appService.getDBDetails(appRequest);
    return new ResponseEntity<>(response, HttpStatus.OK);

}

Here response is the one that service returns with all the data in its pojo format and if we do not give produces in annotation then by default spring will return response json. Can someone guide me? Thanks in advance.

Possible duplicate of How to Return CSV Data in Browser From Spring Controller — Krzysztof Cichocki
– Krzysztof Cichocki, Commented Aug 17, 2017 at 7:59
Spring Boot uses Spring WebMVC under the covers and Spring WebMVC has built-in support for CSV through JasperReports. Alternatively, a custom MessageConverter can be built using any of the popular CSV handling libraries. — manish
– manish, Commented Aug 17, 2017 at 8:02

Pedro Tavares · Accepted Answer · 2017-08-17 08:07:39Z

6

Just using the @GetMapping with produces="text/csv" is not enough. It is only responsible for setting the response header Content-Type: text/csv.

You'll need to add the response as a parameter HttpServletResponse response, convert your POJO into a valid csv file, and only then, write the csv file into the HttpServletResponse.

answered Aug 17, 2017 at 8:07

Pedro Tavares

1,1498 silver badges19 bronze badges

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

1 Comment

user2632905 Over a year ago

This kinda answered my question, but what exactly I did was to use OpenCSV api completed it.

Collectives™ on Stack Overflow

GetMapping to produce CSV file using Spring Boot

1 Answer 1

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related