Postman으로 Spring Boot API를 테스트하는 방법

Postman으로 Spring Boot API를 테스트하는 방법

Spring Boot로 개발한 API를 테스트하기 위해 Postman은 매우 유용한 도구입니다. Postman은 HTTP 요청을 간단히 작성하고 응답을 확인할 수 있는 GUI 기반의 클라이언트로, REST API 테스트에 자주 사용됩니다. 이 글에서는 Postman을 사용해 Spring Boot API를 테스트하는 방법을 단계별로 안내합니다.

---

1. Postman 설치 및 실행

1. Postman 다운로드:

   • Postman 공식 사이트에서 운영 체제에 맞는 버전을 다운로드하여 설치합니다.

2. Postman 실행:

   • 설치 후 Postman을 실행합니다. 회원가입 또는 로그인 후 대시보드 화면에 진입할 수 있습니다.

---

2. Spring Boot API 준비

Spring Boot 프로젝트에서 간단한 API를 작성합니다. 아래 예제는 CRUD 작업을 처리하는 간단한 컨트롤러입니다:

import org.springframework.web.bind.annotation.*;

import java.util.HashMap;
import java.util.Map;

@RestController
@RequestMapping("/api/items")
public class ApiController {

    private Map<Integer, String> items = new HashMap<>();

    @GetMapping
    public Map<Integer, String> getAllItems() {
        return items;
    }

    @PostMapping
    public String createItem(@RequestBody String itemData) {
        int id = items.size() + 1;
        items.put(id, itemData);
        return "아이템이 생성되었습니다: ID = " + id;
    }

    @PutMapping("/{id}")
    public String updateItem(@PathVariable int id, @RequestBody String itemData) {
        if (items.containsKey(id)) {
            items.put(id, itemData);
            return "아이템이 수정되었습니다: ID = " + id;
        } else {
            return "아이템이 존재하지 않습니다.";
        }
    }

    @DeleteMapping("/{id}")
    public String deleteItem(@PathVariable int id) {
        if (items.containsKey(id)) {
            items.remove(id);
            return "아이템이 삭제되었습니다: ID = " + id;
        } else {
            return "아이템이 존재하지 않습니다.";
        }
    }
}

Spring Boot 애플리케이션을 실행하고 API 서버가 정상적으로 동작하는지 확인합니다. 기본 포트는 http://localhost:8080입니다.

---

3. Postman으로 API 테스트하기

1. Postman에서 새 요청 생성:

   • Postman 대시보드에서 "New"를 클릭하고 "Request"를 선택합니다.
   • 요청 이름과 폴더를 설정한 후 "Save"를 클릭합니다.

2. GET 요청 테스트:

   • Method를 GET으로 설정합니다.
   • URL에 http://localhost:8080/api/items를 입력합니다.
   • "Send" 버튼을 클릭하면 모든 아이템의 목록이 반환됩니다.

3. POST 요청 테스트:

   • Method를 POST로 설정합니다.
   • URL에 http://localhost:8080/api/items를 입력합니다.
   • Body 탭을 선택한 후 "raw"와 "JSON" 형식을 선택합니다.
   • 다음과 같은 데이터를 입력합니다:

     "새로운 아이템"

   • "Send" 버튼을 클릭하면 아이템이 생성되었다는 메시지가 반환됩니다.

4. PUT 요청 테스트:

   • Method를 PUT으로 설정합니다.
   • URL에 http://localhost:8080/api/items/1을 입력합니다.
   • Body 탭에서 데이터를 입력합니다:

     "수정된 아이템"

   • "Send" 버튼을 클릭하면 아이템 수정 결과가 반환됩니다.

5. DELETE 요청 테스트:

   • Method를 DELETE로 설정합니다.
   • URL에 http://localhost:8080/api/items/1을 입력합니다.
   • "Send" 버튼을 클릭하면 아이템 삭제 결과가 반환됩니다.

---

4. Postman의 추가 기능 활용

1. 컬렉션(Collection) 관리:

   • 여러 API 요청을 저장하고 관리할 수 있습니다.
   • 대시보드에서 "Collection"을 생성한 후 요청을 추가합니다.

2. 환경 변수 설정:

   • 개발, 테스트, 프로덕션 환경에 따라 변수(예: URL, API 키)를 설정할 수 있습니다.
   • 환경 설정은 "Environment" 메뉴에서 가능합니다.

3. 테스트 스크립트 작성:

   • Postman은 요청 후 응답 값을 검증할 수 있는 JavaScript 기반 스크립트를 지원합니다.
   • Tests 탭에서 스크립트를 작성하여 응답 상태 코드나 데이터를 확인할 수 있습니다.

     pm.test("응답 상태가 200이어야 합니다", function () {
         pm.response.to.have.status(200);
     });

4. API 문서화:

   • Postman은 API 요청과 응답을 기반으로 자동 문서를 생성하는 기능을 제공합니다.

---