[Web] Path Variable VS Query Parameter

REST API를 개발하던 중 endPoint를 설계하던중 GET Method를 통해 데이터를 넘길 경우,

 

Path Variable 과 Query Parameter 를 고민하게 되었고, 정리해보려 한다.

 

각각 상황을 알아보고 적합한 방법을 쓰면 될 것 같다.

 

Path Variable

이름에서도 알 수 있듯이 경로를 변수로 사용한다.

게시물을 확인하기 위해 글번호를 넘길것이다.

/board/12

 

Query Parameter

경로 뒤에 입력 데이터를 함께 제공하는 형식이다.

? 이후에 key=value 형태로 입력하며, 다수인 경우 & 로 구분한다.

--1개의 데이터
/board?board_num=12

--다수의 데이터 &로 처리
/board?board_num=12&key=value

 

 

Path Variable VS Query Parameter

Path Variable은 리소스를 식별하기 위해 사용하고,

데이터를 정렬, 필터링 등을 사용한다면 Query Parameter 가 더 적합하다.

 

예를 들어, Path Variable 인 경우 해당 경로의 리소스가 없는 경우 404 에러가 발생한다.

하지만 Query Parameter 인 경우에는 빈 리스트를 반환할 것이다.

정렬, 필터링을 하려다 404 에러가 나는 경우는 부적절하기 때문에 Query Parameter 가 적합하다고 할 수 있다.