📌 Spring REST API 실습 - MemoRestController 구축 & Postman 테스트

📅 날짜

2025-04-28

---

📝 학습 내용

1️⃣ MemoRestController 설계

• 스프링의 @RestController를 활용하여 메모 관리 API 구현.
• CRUD 중 조회(GET), 등록(POST) 기능 위주로 실습.

---

2️⃣ 주요 코드

✅ 전체 메모 조회

@GetMapping(value = "/getAll", produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
public List<MemoDto> getAll() {
    log.info("GET /rest/memo/getAll");
    return memoService.getAllMemo();
}

• URL 호출: GET http://localhost:8091/ex08_restController/rest/memo/getAll
  
• 응답: JSON 배열 형태로 전체 메모 반환.
  

---

✅ 단건 메모 조회 (ResponseEntity 활용)

@GetMapping(value = "/get/{id}", produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
public ResponseEntity<MemoDto> get(@PathVariable int id) {
    log.info("GET /memo/get... " + id);
    MemoDto dto = memoService.getMemo(id);

    if (dto == null) {
        return new ResponseEntity<>(HttpStatus.NOT_FOUND);
    }
    return new ResponseEntity<>(dto, HttpStatus.OK);
}

• URL 호출: GET http://localhost:8091/ex08_restController/rest/memo/get/8889
  
• 주의: DB에 값이 존재해도 dto가 null이면 404 반환.
  

---

✅ 메모 등록 (POST + JSON Body)

@PostMapping("/post")
public void add(@RequestBody MemoDto dto) throws SQLException {
    log.info("POST /memo/add_rest_post.." + dto);
    memoService.registraionMemo(dto);
}

• URL 호출: POST http://localhost:8091/ex08_restController/rest/memo/post
  
• Postman 설정:
  • Body → raw → JSON

{
  "id": "8890",
  "text": "c",
  "writer": "c",
  "createAt": "2025-04-28T11:34:10"
}

---

3️⃣ Postman 테스트 요약

기능	Method	URL	비고
전체 조회	GET	/rest/memo/getAll	JSON 배열 반환
단건 조회	GET	/rest/memo/get/{id}	JSON 반환 / 404 처리
메모 등록	POST	/rest/memo/post	Body에 JSON 입력

---

4️⃣ 디버깅 포인트

• 응답이 비어있는 경우 점검사항
  1. 서비스 계층(memoService.getMemo) 로직 확인
  2. DTO 직렬화(Jackson) 설정 확인
  3. 서버 로그 & 예외 메시지 확인
  4. Postman 요청 설정 (Method, Headers, Body 등)
• 테스트용 더미 데이터 반환으로 직렬화 여부 체크 권장.

---

🔥 정리

• @RestController와 @RequestBody, ResponseEntity를 활용해 RESTful API 기본 구현.
• Postman을 이용해 GET/POST 요청 테스트 수행.
• 응답이 없을 때는 서비스 로직, 직렬화 설정, 요청 방식 등을 종합적으로 점검.
• 실습을 통해 REST API 흐름과 디버깅 방법을 체득.

---

🔗 참고 자료

• Spring REST Controller 공식 문서
• Postman 활용 가이드
• Jackson 직렬화 문제 해결

---