[Restful] Get방식 요청 (Path Variable VS Query Parameter)

Path Variable

'경로'를 '변수'로 사용하며 path 를 통해 resource를 식별하는 방식으로,
필요한 정보 반환을 위해 경로의 resource를 전달해야 하며, resource 가 없을 경우 404 에러가 발생한다.

https://test.net:/board/detail/2

Query Parameter

'경로' 뒤에 '입력데이터'를 함께 제공하고 '?' 이후 key=value 형태로 입력하며 여러개 일 때에는 '&' 로 구분하는 방식으로, 정렬이나 필터링 또는 검색 기능에서 주로 사용한다.
필수 query parameter가 없다면 데이터를 보내지 않아도 에러는 발생하지 않으며, 결과를 빈값으로 반환하기 때문에 정렬이나 검색이 필요한 경우에 적용된다.

https://test.net:/board/list-search?title='velog'&page=1&size=20

Path Variable VS Query Parameter

Path Variable 은
resource 식별이 필요한 경우; 예를 들어 Selectbox 혹은 Combobox 에서, 특정 데이터를 물고 API 호출해야 하는 경우가 해당된다. 즉, 결과를 반환하기 위해 특정 데이터를 꼭 path의 resource로서 식별하게 되며 필수 Variable라고 말할 수 있다.

Query Parameter 은

빈 데이터를 반환해도 문제가 없는 경우; 대표적으로 검색, 정렬기능이 예시가 될 수 있다.
게시판에서 게시물을 찾을 때 검색조건에 "작성자", "제목", "제목+작성자" 등이 존재하고 아무 검색어를 입력하지 않아도 에러가 발생하지 않는다.