-
Header, BodyREST API 2024. 5. 13. 00:06
REST API를 사용할 때 header와 body는 요청(request)과 응답(response)의 두 주요 구성 요소입니다. 이 둘은 서로 다른 목적을 가지고 있으며, HTTP 통신에서 중요한 역할을 합니다.
Header
헤더는 요청이나 응답의 메타데이터를 포함하고 있습니다. 즉, 본문(body)의 데이터를 어떻게 처리할지에 대한 정보나, 요청/응답을 보내는 주체에 대한 정보 등을 포함합니다. 예를 들면 다음과 같습니다:
- Content-Type: 이 헤더는 요청의 본문이 어떤 데이터 유형을 포함하고 있는지 알려줍니다. 예를 들어, application/json은 JSON 형식의 데이터임을 나타냅니다.
- Authorization: 인증 정보를 포함하여 API가 사용자가 누구인지 확인할 수 있도록 합니다. 예를 들어, Bearer 토큰을 사용하는 경우가 있습니다.
- User-Agent: 요청을 보내는 클라이언트의 정보(예: 웹 브라우저, 운영 체제 등)를 포함합니다.
- Accept: 클라이언트가 받을 수 있는 응답의 데이터 유형을 지정합니다.
Body
본문은 실제 전송하고자 하는 데이터를 담고 있습니다. POST나 PUT 메소드 같은 경우에는 이 본문에 데이터를 포함시켜 서버로 보냅니다. 응답에서도 본문을 통해 데이터를 클라이언트에 전달할 수 있습니다. 예를 들어, JSON 형식으로 정보를 주고받는 것이 일반적입니다.
예시를 통해 더 자세히 설명하자면, 클라이언트가 서버에 로그인 요청을 보낼 때, 요청 헤더에는 Content-Type: application/json과 Accept: application/json을 포함하고, 요청 본문에는 {"username": "user", "password": "pass"}와 같은 로그인 정보를 JSON 형식으로 보냅니다. 서버는 이 요청을 처리한 후, 응답 헤더와 함께 JSON 형식의 데이터를 포함한 응답 본문을 클라이언트로 다시 보냅니다.
이처럼 헤더와 본문은 REST API를 사용하여 데이터를 주고받는 과정에서 각각의 역할을 수행하여 통신의 효율성과 명확성을 높입니다.
반응형