Spring rest controller and paging

Question

I use spring 4.2 and rest and I would like to use paging.

What is the way to use paging with spring rest controller?

@RequestMapping(value = "/members/{memberId}/payments", method = RequestMethod.GET)
    public Page<PaymentDto> getPaymentByMemberId(@PathVariable("memberId") Long memberId, Pageable pageable) {
        return paymentService.getPaymentByMemberId(memberId, pageable);
    }

Is it a good way to manage this?

If for some area in the application, we don't want to use paging, We need to create another url?

if I want all payments for a member, I will do:

/members/{memberId}/payments

and for the paging, it's there a way to said to spring to do something like:

/members/{memberId}/payments?pageNumber=1&PageSize=10

Did you find how to work with `Pageable`? – Jin Kwon Nov 03 '17 at 02:48 — Jin Kwon, Nov 03 '17 at 02:48

score 4 · Answer 1 · answered May 08 '16 at 03:12

One way to do this is:

@RequestMapping(value = "/members/{memberId}/payments", method = RequestMethod.GET) 
public List<PaymentDto> getPaymentByMemberId(@PathVariable("memberId") Long memberId, @RequestParam(value = "pageNumber", required = false) final Integer pageNumber,@RequestParam(value = "pageSize", required = false) final Integer pageSize) {
                PageRequest pageReq = new PageRequest((pageNumber == null ? 0 : pageNumber), (pageSize == null ? 0 : pageSize));
                Page<PaymentDto> page = paymentService.getPaymentByMemberId(memberId, pageReq);
                return page.getContent();
        }

score 0 · Answer 2 · answered Sep 17 '19 at 16:08

You need write annotation @RestController for your controller

@RestController
public class PaymentController {
...
    @RequestMapping(value = "/members/{memberId}/payments", method = RequestMethod.GET)
    public Page<PaymentDto> getPaymentByMemberId(@PathVariable("memberId") Long memberId, Pageable pageable) {
        return paymentService.getPaymentByMemberId(memberId, pageable);
    }
}

Request example: /members/12345/payments?page=0&size=50

Spring rest controller and paging

2 Answers2