[백엔드] Query Parameter와 Path Variable의 사용

개요

백엔드 API 개발 시 GET 메서드를 통해 데이터를 어떻게 전송해야 하는지 늘 고민이다. GET 메서드에서 전송 방법은 크게 Query Parameter와 Path Variable 방법이 있다.

 

Query Parameter의 예는 다음과 같다.

/user?id=1234

 

Path Variable의 예는 다음과 같다.

/user/1234 

 

두 주소 모두 ID가 1234인 유저를 가져오는 방법이라 했을 때 어느게 적합한가? 보통 정석은 어떤 자원(Resource)를 식별할 때는 path variable을 사용하고, 정렬이나 필터링이 필요로 할 때는 query parameter를 사용한다.

 

 

이런 코딩 컨벤션(convention)을 정립하는게 최근 새로이 중요하다고 생각된다.