[nodejs] REST API를 위한 요청 및 응답 형식(JSON, XML)

REST API를 구현할 때 클라이언트와 서버 간에 데이터를 주고받기 위한 요청과 응답은 주로 JSON 또는 XML 형식으로 이루어집니다. 이 블로그 포스트에서는 각각의 형식에 대한 요청과 응답의 예시를 확인해보겠습니다.

JSON 형식

JSON(JavaScript Object Notation)은 경량의 데이터 교환 형식으로, 텍스트 형식으로 구조화된 데이터를 표현합니다. 일반적으로 REST API에서는 JSON 형식을 사용하여 데이터를 요청하고 응답합니다.

요청 예시

다음은 JSON 형식으로 작성된 REST API 요청의 예시입니다.

{
  "userId": 1,
  "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
  "body": "quia et suscipit\nsuscipit recusandae consequuntur expedita et cum\nreprehenderit molestiae ut ut quas facere repellendus"
}

응답 예시

다음은 JSON 형식으로 작성된 REST API 응답의 예시입니다.

{
  "id": 101,
  "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
  "userId": 1
}

XML 형식

XML(Extensible Markup Language)은 데이터를 저장하고 전송하기 위한 다목적 마크업 언어로, 구조화된 데이터를 표현합니다. 일부 시스템에서는 여전히 XML을 통한 데이터 교환을 선호하는 경우가 있습니다.

요청 예시

다음은 XML 형식으로 작성된 REST API 요청의 예시입니다.

<user>
  <id>1</id>
  <name>John Doe</name>
  <email>john.doe@example.com</email>
</user>

응답 예시

다음은 XML 형식으로 작성된 REST API 응답의 예시입니다.

<user>
  <id>1</id>
  <name>John Doe</name>
  <email>john.doe@example.com</email>
  <status>active</status>
</user>

데이터 교환 형식을 선택할 때는 클라이언트와 서버 간의 상호 호환성과 데이터의 구조에 따라 JSON 또는 XML을 선택하는 것이 중요합니다.