API Param vs Query Parameter 개념과 차이

🤷‍♂️ 본론에 앞서

---

최근에 새로운 조직에서 풀스택으로 프론트 & 백엔드 업무를 담당을 맡으면서 새로운 기술스택과 아키텍처 그리고 팀 컨벤션과 업무방식을 적응하면서 새로운 것에 대해서 많은 습득과 공부를 하고있습니다.

 

최근에 백엔드 REST API를 담당하면서 Param & Query Parameter에 대한 차이에 대해서 깊이 생각을 하게 되면서 어떠한 설계가 좋은 방식인지 아닌지 고민을 하게 되었습니다.

 

🤷‍♂️ Param & Query Parameter 사용 방법의 차이?

---

API GET 메소드 종류

API 요청에 GET 메소드를 컨트롤하기 위한 2가지 형태를 담고있다.

• Param
• Query

 

 

Param?

• 주소에 포함된 변수의 값을 처리합니다.
• http://localhost:3000/blog/8763 주소에서 8763 값을 Path Parameter 부릅니다.
• 서버에서는 /:blogId 이런 형태로 라우터 값을 받아와서 처리 할수 있습니다.
• 필터링 or 정렬 처럼 옵셔널한 값이 아닌 유일한 값을 식별할때 사용합니다.

 

Query?

• URL 끝에 ? 물음표 뒤에 나타나는 값 http://localhost:3000/blog?type=all&lang=kr ? 뒤에 key와 value 형태로 &(and) 기호로 key=value 형태로 구분됩니다. 아래와 같은 상황에서 많이 사용됩니다.
  • 데이터 필터링
  • 데이터 정령
  • 검색
  • 데이터 페이지네이션
• 필요한 조건을 요청에 처리해야 되는 상황에서 필수값이 아닌 옵셔널한 값일때 사용합니다.

 

같이 공부하면 좋은 URL 인코드와 디코드 변환하는 방법과 개념

https://cometruedream.tistory.com/225

URL 인코드와 디코드 변환하는 방법과 개념

 

 

🤷‍♂️ Param & Query 차이?

---

Param과 Query에 차이에 대해서 생각해보면 결론적으로는 팀의 컨벤션과 문화를 맞춰서 API URI 설계하는것이 가장 좋은 방식이라고 생각합니다.

소속된 본부 혹은 팀에 특별한 규칙이 없다면 필수 값이 요구되는 상황에는 Param을 사용하고 옵션널한 값이 필요할때는 Query를 사용하면 됩니다.

 

더해서, 필수값과 옵셔널한 값의 차이도 있지만 가독성의 차이도 있습니다.

 

1: /blog?id=kefef

vs

2: /blog/kefef

 

* 위에 URI 형태를 보면 1번의 Query형태가 무슨의미인지 직관적으로 나타냅니다.

 

 

 

 

 

두개의 URI를 봤을때 가독성 면에서는 1번 URI가 직관적이고 가독성면에서 좋습니다.

그에 비해 2번째 URI는 직관적으로 무슨 의미인지를 1번 URI 보다 가독성이 좋지 않습니다.

Param 보다는 Query 직관적이고 가독성면에서 더 좋다고 판단됩니다.

 

가독성과 직관적인 부분의 기준은 주관적이기 때문에 팀의 컨벤션 혹은 문화에 맞춰서 API 설계를 따르거나 팀에 규칙이 없다면 REST API 정석을 따르면서 URI를 설계하면 좋을꺼 같습니다.

 

🤷‍♂️ Param & Query 정리하자면

---

Param & Query Parameter 중에 API URI를 어떻게 설계할지 고민이 될때는 REST API 정석을 따르면 Param 유일한 값에 정의가 필요할때 Query 옵셔널한 값의 정의가 필요할때 사용하면 됩니다.

 

 

---

 

재밌는 오늘의 띠별 운세 보고 가세요! 

 

 

 

https://cometruedream.tistory.com/243

NestJS Lifecycle (생명주기) 개념

 

 

https://cometruedream.tistory.com/242

리액트 Vite Proxy 활용한 CORS 오류 해결

 

 

https://cometruedream.tistory.com/241

React 폴더구조 FSD 기능 분활 설계 아키텍처

 

 

https://cometruedream.tistory.com/244

쉽게 이해하고 사용할수 있는 Prisma 명령어 정리