Path Variable VS Query Parameter

1. Path Variable

@GetMapping("/{userId}")
public String findUser(@PathVariable String userId){
    return "get userId=" + userId;
}

서버로 데이터를 넘기는 방법 중 하나인데 url 경로 내에 리소스를 추가하는 방법이다.

2. Query Parameter

@ResponseBody
@RequestMapping("/order")
public String requestParamRequired(
        @RequestParam(required = true) String username,
        @RequestParam(required = false) Integer age){

    log.info("username={}, age={}", username, age);
    return "ok";
}

Query Parameter 또한 서버로 데이터를 넘기는 방법 중 하나인데 key-value 형식으로 앞에 ?를 붙이고 한 쌍의 key-value마다 &로 연결해주면 된다.

EX) /order?username=kim&age=24

3. 둘 중에 무엇을 써야 하나?

크게 두 경우로 나눌 수 있다.

첫 번째는, 특정한 리소스를 식별하고 싶다면 Path Variable을 사용한다.

두 번째는, 어떠한 값을 기준으로 필터링 또는 정렬을 한다면 Query Parameter를 사용한다.

EX) 고객 아이디가 ex12인 사람이 2022년 7월 1일부터 2022년 7월 23일까지의 주문 내역을 GET

1. /order/ex12?startDate=20220701&endDate=20220723

2. /order?userId=ex12&startDate=20220701&endDate=20220723

둘 중에 어떤 게 더 적합할까?

나는 userId는 order의 key가 되지는 못한다. 따라서 2번 방식이 더 적합하다고 생각한다.