Query Parameter와 Path Variable을 알아보자

Query Parameter란?

토스 페이먼츠 개발자 센터의 참고 이미지

쿼리 파라미터는 URL의 끝부분에 "?" 뒤에 위치하며, 데이터를 키=값 쌍으로 전달한다. 여러 쌍이 있을 경우 &로 구분한다. 보통 검색 필터링, 페이지네이션 등과 같은 비필수적인 데이터를 전달할 때 사용된다.

특징

• 위치: URL 끝에 ? 뒤에 작성된다.
  • 예시: https://example.com/products?category=shoes&color=black
• 다중 파라미터 지원: 여러 파라미터를 &로 구분해서 보낼 수 있다.
• 가변적 사용: 파라미터는 필수적이지 않으며 필요에 따라 추가하거나 생략할 수 있다.
• RESTful 규칙: 쿼리 파라미터는 데이터 조회와 같은 GET 요청에서 주로 사용되며 서버에 상태를 변경하는 작업을 할 때는 사용하지 않는 것이 일반적이다.

Path Variable

패스 베리어블은 URL 경로의 일부로 사용되어 데이터의 특정 자원을 식별한다. 리소스의 고유 ID나 이름을 URL 경로에 포함시켜 RESTful한 API 요청에서 자주 사용된다.

특징

• 위치: URL 경로의 일부분으로 사용되며 보통 리소스나 특정 자원의 고유 식별자를 포함한다.
  • 예시: https://example.com/products/123
• 고정된 위치: 특정 경로에 명시된 위치에 베리어블이 들어가기 때문에 순서가 중요하다.
• RESTful 규칙: 리소스의 특정 항목을 조회하거나 조작할 때 주로 사용되며, GET, POST, PUT, DELETE와 같은 모든 HTTP 메소드에서 사용 가능하다.

Query Parameter VS Path Variable

쿼리 파라미터	패스 베리어블
URL의 "?" 뒤에 위치	URL 경로의 일부
필터링, 검색, 페이지네이션 등 비필수적 정보 전달	리소스의 고유 식별자를 전달
다중 파라미터를 지원하고 &로 구분	제한적으로 다중 파라미터를 지원하고 고정된 경로에 따라 하나씩 사용
GET 요청에 주로 사용, 조회 시 적합	모든 HTTP 메소드에서 사용 가능
조건이 많아질수록 URL이 길어질 수 있음	URL이 간결하고 자원 식별이 직관적
URL에 노출되므로 민감한 정보에 적합하지 않음	URL에 노출되므로 민감한 정보에 적합하지 않음

참고문헌

쿼리 파라미터(Query Parameter) | 토스페이먼츠 개발자센터