Colin's Blog
[java] TestNG와 Postman을 활용한 API 테스트

API 테스트는 소프트웨어 개발에서 매우 중요한 요소입니다. 이를 통해 개발된 API가 예상대로 동작하는지 확인할 수 있으며, 문제가 발생할 경우 이를 수정하기 위한 기준점을 제공합니다.

TestNG는 자바 기반의 유닛 테스팅 프레임워크로, API 테스트에 많이 활용됩니다. Postman은 API 개발 및 테스트 도구로, 그래픽 사용자 인터페이스를 통해 간편하게 API를 테스트할 수 있습니다.

이번 글에서는 TestNG와 Postman을 활용하여 API 테스트를 수행하는 방법에 대해 알아보겠습니다.

환경 설정

  1. Java 설치 - TestNG는 Java 기반으로 동작하므로, Java를 설치해야 합니다. Java를 설치하는 방법은 다음 링크를 참조하세요: Oracle Java 다운로드

  2. IntelliJ IDEA 설치 - IntelliJ IDEA는 인텔리J를 개발한 JetBrains에서 만든 통합 개발 환경입니다. IntelliJ IDEA를 설치하기 위해서는 JetBrains 홈페이지(https://www.jetbrains.com/idea/)를 방문하세요.

  3. TestNG 플러그인 설치 - IntelliJ IDEA에서 TestNG를 사용하기 위해서는 TestNG 플러그인을 설치해야 합니다. IntelliJ IDEA에서 플러그인을 설치하는 방법은 다음의 링크를 참조하세요: IntelliJ IDEA TestNG 플러그인 설치

  4. Postman 설치 - Postman을 사용하기 위해서는 Postman 클라이언트를 먼저 설치해야 합니다. 다운로드 링크는 다음과 같습니다: Postman 다운로드

API 테스트 작성

  1. TestNG 프로젝트 생성 - IntelliJ IDEA를 실행하고 새로운 프로젝트를 생성합니다. 이때 프로젝트 유형은 Maven을 선택합니다.

  2. Maven 의존성 추가 - Maven 프로젝트에는 TestNG 의존성을 추가해야 합니다. 이를 위해 pom.xml 파일을 열고 다음 코드를 추가합니다:

<dependencies>
    <dependency>
        <groupId>org.testng</groupId>
        <artifactId>testng</artifactId>
        <version>7.0.0</version>
    </dependency>
</dependencies>
  1. API 테스트 작성 - src/test/java 폴더에 새로운 Java 클래스를 생성하고, 아래 코드를 작성합니다.
import org.testng.Assert;
import org.testng.annotations.Test;

import io.restassured.RestAssured;
import io.restassured.response.Response;

public class ApiTests {

    @Test
    public void testApi() {
        Response response = RestAssured.get("https://api.example.com/users/1");

        int statusCode = response.getStatusCode();
        Assert.assertEquals(statusCode, 200, "Expected status code 200");

        String responseBody = response.getBody().asString();
        Assert.assertTrue(responseBody.contains("John Doe"), "Expected response body contains 'John Doe'");
    }
}

위 코드는 간단한 API 테스트를 수행하는 예시입니다. get 메소드를 사용하여 https://api.example.com/users/1 URL에 GET 요청을 보내고, 응답을 검증합니다.

  1. TestNG 실행 - IntelliJ IDEA에서 ApiTests 클래스에서 마우스 오른쪽 버튼을 클릭하고, “Run ‘ApiTests’“를 선택하여 TestNG 테스트를 실행합니다.

Postman을 이용한 API 테스트

  1. Postman 실행 - Postman 클라이언트를 실행합니다.

  2. 새로운 요청 생성 - Postman에서 새로운 요청을 생성하기 위해 “New” 버튼을 클릭합니다.

  3. 요청 설정 - 요청 URL을 입력하고, 필요한 헤더와 파라미터를 추가합니다. 그런 다음, “Send” 버튼을 클릭하여 테스트를 실행합니다.

  4. 응답 검증 - Postman은 응답 결과를 상세하게 표시해주므로, 응답을 검증하고 문제가 있는 경우 수정합니다.

마무리

TestNG와 Postman을 활용하여 API 테스트를 수행하는 방법에 대해 알아보았습니다. 이를 통해 개발된 API가 예상대로 동작하는지 확인할 수 있으며, 문제 발생 시 쉽게 수정할 수 있습니다. 이를 통해 소프트웨어의 품질을 향상시킬 수 있습니다.

© 2018 Colin. All rights reserved.