API 요청에서 path, query, body의 차이점

path, query, body의 차이점

 

path, query, body를 통해 응답에 필요한 정보를 클라이언트로부터 받을 수 있다.

물론 헤더로도 받을 수 있지만 여기서는 넘어가겠다.

하지만 각각에게 기대되는 정보는 다르다.

 

path

URI는 resource 혹은 representation을 구분하기 위해 사용된다.

대부분 URI의 URL을 사용해서 리소스의 경로를 표현한다. (둘은 동일하게 봐도 무방하다)

path는 오직 리소스에 초점을 두어 사용하도록 권장된다. 다르게 표현하면, 행위(메서드)를 포함하지 않는다.

 

Ex>

• /articles
• /members
• /search

 

query

get 요청에 필요한 tag, filter, 검색 keyword가 될 수 있다.

 

Ex>

구글에 무한도전을 검색하면 다음과 같은 query로 서버에 요청한다.

?q=%EB%AC%B4%ED%95%9C%EB%8F%84%EC%A0%84&sourceid=chrome

위 쿼리는 이어지는 key-value들의 합이다.

• q=%EB%AC%B4%ED%95%9C%EB%8F%84%EC%A0%84
• sourceid=chrome

URL Encoding으로 무한도전이 "%EB%AC%B4%ED%95%9C%EB%8F%84%EC%A0%84"이 되었고

크롬환경에서 요청되었다는 의미이다.

 

body

post, put, patch 등의 데이터 전송을 위해서 필요하다.

 

참고

Enjoy Encoding & Decoding

https://dencode.com/

위 사이트에서 무한도전이나 %EB%AC%B4%ED%95%9C%EB%8F%84%EC%A0%84을 넣어 값을 확인할 수 있다.