스프링 부트(Spring Boot)를 활용한 PUT REST API 구현

스프링 부트(Spring Boot)를 활용하여 HTTP Method중 하나인 PUT REST API를 구현하는 방법에 대해 알아보자.

@RestController는 해당 class가 RestAPI를 처리하는 Controller로 등록하겠다는 의미에서 사용된다.

 

 

<@JsonProperty 활용 방법>

① 카멜 케이스(Camel Case)인 footSize property에 대해 @JsonProperty("foot_size") 스네이크 케이스(Snake Case)로

    설정해주게 되면 API 요청 시 보내는 JSON 데이터의 key 값이 foot_size로 들어와도 footSize로 매핑이 된다.

② @PutMapping에 path라는 속성으로 요청이 들어올 세부 URL에 대한 path를 지정해준다.

③ REST API 요청 시 body에 담겨 들어오는 데이터들을 받기 위해 메서드의 파라미터 정보에 대해서 @RequestBody를

    넣고 타입은 모델 class로 설정한다.

④ PUT으로 설정한 뒤 요청을 보낼 URL인 localhost:8080/api/test/put-method1을 셋팅한다.

⑤ 데이터를 작성하기 위해 Body를 클릭하고 json형식의 데이터를 보낼 것이기 때문에 Content-Type은 application/json으로 셋팅한다.

⑥ raw를 클릭하고 JSON으로 셋팅한다.

⑦ JSON 형식의 보낼 데이터를 작성한다.

⑧ Send 버튼을 클릭하여 PUT REST API를 호출한다.

⑨ return 받은 값을 보면 API 요청 시 보낸 JSON 데이터의 key 값과 모델 class의 property와 일치하지 않은 foot_size

   까지 정상적으로 Body에 담긴 것을 확인할 수 있다.

 

 

<@JsonNaming 활용 방법>

① class위에 @JsonNaming(value = PropertyNamingStrategy.SnakeCaseStrategy.class)를 설정해주게 되면

VO의 모든 property들이 카멜 케이스(Camel Case)이고 API 요청 시 보내는 JSON 데이터의 key 값이 스네이크 케이스(Snake Case)로 들어와도 매핑이 된다.

② @PutMapping에 path라는 속성으로 요청이 들어올 세부 URL에 대한 path를 지정해준다.

③ REST API 요청 시 body에 담겨 들어오는 데이터들을 받기 위해 메서드의 파라미터 정보에 대해서 @RequestBody를

    넣고 타입은 모델 class로 설정한다.

④ PUT으로 설정한 뒤 요청을 보낼 URL인 localhost:8080/api/test/put-method1을 셋팅한다.

⑤ 데이터를 작성하기 위해 Body를 클릭하고 json형식의 데이터를 보낼 것이기 때문에 Content-Type은 application/json으로 셋팅한다.

⑥ raw를 클릭하고 JSON으로 셋팅한다.

⑦ JSON 형식의 보낼 데이터를 작성한다.

⑧ Send 버튼을 클릭하여 PUT REST API를 호출한다.

⑨ return 받은 값을 보면 API 요청 시 보낸 JSON 데이터의 key 값과 모델 class의 property와 일치하지 않은 foot_size

   까지 정상적으로 Body에 담긴 것을 확인할 수 있다.

 

 

 

<잘못된 예시>

① 이번엔 REST API 호출 시 보낸 데이터가 메서드 내부에 정상적으로 들어오지 않을 경우를 보여주고자 한다.

    메서드의 파라미터 정보에 @RequestBody를 빼고 설정한다.

② Send 버튼을 클릭하여 PUT REST API를 호출한다.

③ return 받은 값을 보면 Body에 아무것도 안담긴 것을 보아 @RequestBody는 반드시 넣어줘야 하는 것을 볼 수 있다.