Path Parameter와 Query String은 RESTful API 설계에서 중요한 개념이다.
RESTful API에서 Path Parameter와 Query String은 중요한 개념이다.
이에 각각의 특징과 용도를 적절히 사용하기 위한 개념을 정리 해보고자 한다.
Path Parameter:
URL 경로의 일부로 사용되며, 주로 특정 리소스를 식별하는 데 사용된다.
_예: /users/{userId}, /products/{productId}_Path Parameter는 해당 리소스를 고유하게 식별하는 필수 정보로 간주된다.
URL에 직접 포함되므로 클라이언트에게 영향을 미치므로 Path Parameter의 변경은 클라이언트 코드의 수정을 필요로 할 수 있다.
Query String:
URL 끝에 ?로 시작하여 key-value 쌍으로 구성된 파라미터를 전달하는 방식이다.
주로 검색, 필터링, 정렬 등의 추가 정보를 전달하는 데 사용된다.
예: /users?sort=name&limit=10, /products?category=electronics&price=1000Query String의 특징
- 선택적인 정보를 전달하는데에 이용 됨.
- 리소스 식별에 필수적이지 않다.
- Path Parameter에 비해 상대적으로 쉽게 변경가능, 클라이언트 코드 수정없이도 서버에서 수정이 용이
요약
1.리소스를 식별하는 필수 정보는 Path Parameter로 전달하고, 선택적인 정보는 Query String으로 전달한다.
2.Path Parameter는 변경 시 클라이언트에게 영향을 미치므로 신중하게 설계해야 한다. 안정적인 설계를 위해 Path Parameter의 변경을 최소화하는 것이 좋다.
Query String은 상대적으로 유연하게 확장할 수 있다. 새로운 파라미터를 추가하거나 기존 파라미터를 변경하더라도 클라이언트 코드의 수정 없이 처리할 수 있다.
예를 들어, 블로그 API를 설계한다고 가정할 떄.
특정 게시물을 조회하는 경우: /posts/{postId}와 같이 Path Parameter를 사용한다.
게시물 목록을 필터링하거나 정렬하는 경우: /posts?category=tech&sort=date와 같이 Query String을 사용한다.
이렇게 Path Parameter와 Query String을 적절히 조합하여 사용함으로써 직관적이고 확장 가능한 API를 설계할 수 있다.
