POST API 만들기

POST API

💡

저장하고자 하는 리소스나 값을 body에 담아서 서버에 전달하는 방식

body는 보통 JSON 형식으로 주고받는다. (XML도 있긴하다.)

---

공통 URL 생성하기

package com.springboot.api.controller;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/api/v1/post-api")
public class PostController {
    
}

---

@RequestBody를 활용한 POST 메서드 구현

2가지 방식으로 구현한다.

1. 어떤 형태로 값이 들어오게 될 지 특정하기 어려울 때

   ⇒ Map 클래스를 이용하여 매핑한다.

   @PostMapping(value="/member")
   public String postMember(@RequestBody Map<String, Object> postData){
       StringBuilder sb = new StringBuilder();
   
       postData.entrySet().forEach(map->{
           sb.append(map.getKey()+" : "+map.getValue()+"\n");
       });
   
       return sb.toString();
   }

   다음 URI와 BODY를 POST 방식으로 전달한 결과이다.

   💡

   http://localhost:8080/api/v1/post-api/member

   {
     "name":"Hong",
     "age":2400,
     "email":"test@test.com"
   }

   

2. 어떤 형태로 값이 들어오게 될 지 특정할 수 있을 때

   ⇒ DTO 객체를 이용하여 매핑한다.

   @PostMapping(value="/member2")
       public String postMember2(@RequestBody MemberDTO memberDTO){
           return memberDTO.toString();
       }

   다음 URI와 BODY를 POST 방식으로 전달한 결과이다.

   💡

   http://localhost:8080/api/v1/post-api/member

   {
     "name":"Hong",
     "organization":"test",
     "email":"test@test.com"
   }

   

Q1. DTO 방식에서 없는 속성쌍을 집어넣으면 어떻게 되는가?

다음 URI와 BODY를 POST 방식으로 전달한 결과이다.

💡

http://localhost:8080/api/v1/post-api/member2

{
  "name":"Hong",
  "organization":"test",
  "email":"test@test.com",
  "age":123123
}

다음과 같이 없는 내용은 추가되지 않는다.

Q2. DTO 방식에서 속성을 부족하게 집어넣으면 어떻게 되는가?

다음 URI와 BODY를 POST 방식으로 전달한 결과이다.

💡

http://localhost:8080/api/v1/post-api/member2

{
  "name":"Hong",
  "organization":"test"
}

다음과 같이 없는 내용은 null 값을 가진다.

값이 들어오는 형태가 결정되면 DTO 방식으로 간결한 코드가 완성됨을 알 수 있다.

---

Uploaded by N2T