API의 Request 방식

두주·2023년 12월 26일
0

TIL

목록 보기
23/58

웹 API에서 요청을 하는 방식으로 주로 사용되는 param, query, body는 각각 데이터를 전송하는 방식과 목적에 차이가 있다.

  1. Param(Path Parameter)
    용도 : 주로 특정 리소스나 객체를 식별하는 데 사용된다.
    예시 : /users/{userId} 에서 {userId} 부분이 param이다. 여기서 사용자의 고유 ID를 지정하여 특정 사용자의 정보를 요청할 수 있다.
    특징 : URL 경로의 일부분으로 포함되며, 각 리소스를 구분하는 데 핵심적인 역할을 한다.
  2. Query (Query String)
    용도 : 필터링, 정렬, 페이지네이션 등의 추가적인 옵션을 제공할 때 사용된다.
    예시 : /users?age=30&sort=name에서 age=30과 sort=name 부분이 query이다. 이를 통해 30세 사용자들을 이름순으로 정렬하여 요청할 수 있다.
    특징 : URL의 끝에 ? 다음에 위치하며, 여러 개의 쿼리를 & 기호로 연결할 수 있다.
  3. Body
    용도 : 주로 POST나 PUT 요청에서 사용되며, 크고 복잡한 데이터를 전송할 때 사용된다.
    예시 : 사용자의상세 정보를 생성하거나 수정할 때, {"name": "John", "age": 30} 같은 JSON 형태의 데이터를 body에 담아 보낸다.
    특징 : URL에 직접적으로 노출되지 않으며, 데이터의 양이 많거나 복잡한 경우에 적합하다.
  4. 결론
    param은 특정 리소스를 식별하는 데, query는 추가적인 옵션을 제공하는 데, body는 복잡하거나 큰 데이터를 전송하는 데 주로 사용된다.

출처 : https://velog.io/@qoxowkd0716/T.I.L-34-%EC%88%98%EC%A0%95-%EC%82%AD%EC%A0%9C-API%EC%9D%98-request%EB%A5%BC-%ED%95%98%EB%8A%94-%EB%B0%A9%EC%8B%9D-param-query-body

더 공부할 것 (REST API Naming Guide)
https://velog.io/@caesars000/RESTful-API-%EA%B0%80%EC%9D%B4%EB%93%9C

profile
야옹.

0개의 댓글