[Spring Boot] REST API - POST (+ Talend API Tester)

https://chrome.google.com/webstore/detail/talend-api-tester-free-ed/aejoelaoggembcahagimdiliamlcdmfm?hl=ko

Talend API Tester - Free Edition - Chrome 웹 스토어

크롬 확장프로그램인 Talend API Tester를 사용하여 JSON 형식의 요청 및 응답을 확인해 보겠다.

 

 

PostApiController

 

위 컨트롤러 클래스에는 HTTP 요청을 처리하고 응답을 반환하는 코드가 들어있다.

(코드 설명은 주석 확인)

 

 

BookRequest

데이터 구조를 정의하는 코드이다.

 

 

Talend API Tester

POST 메서드, URL, 전송할 json 데이터인 Body를 입력하고,

요청을 보낸다.(Send 버튼)

 

 

Response

요청이 200 상태 코드와 함께 성공적으로 수행되었음 확인할 수 있다.

json 형태의 응답이 내려간 것을 확인.

 

 

콘솔

콘솔도 확인.

 

 

* 통신 과정 

1. 클라이언트가 POST 요청을 보낸다.

클라이언트는 JSON 형식의 데이터를 포함한 POST 요청을 /api/post 경로로 보낸다.

 

2. PostApiController에서 요청을 수신한다.

@PostMapping("/post") 어노테이션이 붙은 메서드가 요청을 처리한다.

 

3. JSON 데이터를 BookRequest 객체로 변환한다.

@RequestBody 어노테이션을 통해 HTTP 요청 본문이 BookRequest 객체로 자동 변환된다. 메서드 내부에서는 변환된 BookRequest 객체를 사용하여 필요한 로직을 수행할 수 있다. 위 코드에서는 단순히 객체를 콘솔에 출력하고 반환한다.

 

4. 응답을 클라이언트에게 반환한다.

메서드는 BookRequest 객체를 반환하며, 이 객체는 JSON 형식으로 자동 변환되어 클라이언트에게 응답으로 전송된다.

 

 

* json 형식

// "key" : "value"

{
  "array" :  {  // 배열 내 타입은 동일해야 함
    10,
    20,
    30
  },
  
  "string_array" : {
    "홍길동", "이순신", "유관순"
  },

  "object_array" : {
    {
      "name" : "홍길동",
    },
    {
      "name" : "홍길동",
    },
    {
      "name" : "홍길동",
    }
    }
 }