Introduction to API Testing with Java, HttpClient, Gson, and JUnit

Introduction to API Testing with Java

Welcome to the first lesson of the course Automating API Tests with Java . In this course, we will focus on the critical aspect of API testing, specifically from the perspective of an API client, ensuring that the API behaves as expected from the consumer's end. As software systems become more interconnected through APIs, the reliability and stability of these interfaces have a direct impact on the client experience. By testing APIs, clients can verify that they receive accurate, consistent data and that the API performs as intended in various circumstances. We will introduce you to JUnit, a powerful Java framework that simplifies the process of writing and running tests. By leveraging JUnit, along with HttpClient for making HTTP requests and Gson for handling JSON data, you will be equipped to efficiently ensure the APIs you rely on are dependable, fostering greater confidence and trust in software integrations.

What is JUnit and How It Works

JUnit is a popular and powerful testing framework for Java that is designed to make testing simple and scalable. It is used for writing simple as well as complex functional test cases and can be leveraged for API testing. JUnit stands out due to its simple syntax, robust assertion capabilities, and ability to integrate various test fixtures and plugins. Here’s how JUnit works: Test Discovery : JUnit automatically identifies test methods within test classes. By default, it looks for methods annotated with @Test . Running Tests : Once tests are discovered, JUnit executes them and provides a detailed report of the outcomes. It captures any exceptions raised during test execution, displaying any errors and their stack trace if a test fails. Assertions : JUnit provides a variety of assertion methods to verify expected outcomes. This makes it easier to find out why a test failed. Fixtures : JUnit supports test setup and cleanup activities. You can define reusable testing code that helps manage the state and configuration needed by your tests through setup and teardown methods. By using JUnit, developers can efficiently verify that their APIs and applications are working as expected, ensuring quality and reliability in software projects.

Arrange-Act-Assert (AAA) Pattern

The Arrange-Act-Assert (AAA) pattern is a widely used pattern in software testing that helps structure your test cases in a clear, logical, and consistent manner. This pattern makes tests more readable and maintainable by dividing them into three distinct phases: Arrange : This phase involves setting up all necessary preconditions and inputs required for your test. In the context of API testing, this could involve defining any required data setup. Act : In this phase, you perform the action that triggers the behavior you want to test. For API tests, this usually involves making a request to the API endpoint you've set up. Assert : The final phase is where you verify that the outcome of the "Act" phase matches your expectations. This is done using assertions to check the response from the API, ensuring it behaves as expected. Using the AAA pattern helps keep your tests organized and ensures that each test follows a consistent structure. This makes it easier to understand and maintain your test cases over time. Let's apply the AAA pattern in the next section by creating a basic test with JUnit .

Join the 1M+ learners on CodeSignal

Be a part of our community of 1M+ users who develop and demonstrate their skills on CodeSignal

Java

import org.junit.jupiter.api.Test;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TodoApiTest {

    private static final String BASE_URL = "http://localhost:8000";

    @Test
    public void testGetAllTodos() throws Exception {
        // Arrange
        String url = BASE_URL + "/todos";
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
                .uri(new URI(url))
                .build();

import org.junit.jupiter.api.Test;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TodoApiTest {

    private static final String BASE_URL = "http://localhost:8000";

    @Test
    public void testGetAllTodos() throws Exception {
        // Arrange
        String url = BASE_URL + "/todos";
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
                .uri(new URI(url))
                .build();

Java

import org.junit.jupiter.api.Test;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TodoApiTest {

    private static final String BASE_URL = "http://localhost:8000";

    @Test
    public void testGetAllTodos() throws Exception {
        // Arrange
        String url = BASE_URL + "/todos";
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
                .uri(new URI(url))
                .build();

        // Act
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

import org.junit.jupiter.api.Test;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TodoApiTest {

    private static final String BASE_URL = "http://localhost:8000";

    @Test
    public void testGetAllTodos() throws Exception {
        // Arrange
        String url = BASE_URL + "/todos";
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
                .uri(new URI(url))
                .build();

        // Act
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Java

import org.junit.jupiter.api.Test;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import com.google.gson.Gson;
import com.google.gson.reflect.TypeToken;
import java.lang.reflect.Type;
import java.util.List;
import static org.junit.jupiter.api.Assertions.*;

public class TodoApiTest {

    private static final String BASE_URL = "http://localhost:8000";

    @Test
    public void testGetAllTodos() throws Exception {
        // Arrange
        String url = BASE_URL + "/todos";
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
                .uri(new URI(url))
                .build();

        // Act
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

        // Assert
        assertEquals(200, response.statusCode());
        Gson gson = new Gson();
        Type todoListType = new TypeToken<List<Todo>>() {}.getType();
        List<Todo> todos = gson.fromJson(response.body(), todoListType);
        assertNotNull(todos);
        assertFalse(todos.isEmpty());
    }
}

import org.junit.jupiter.api.Test;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import com.google.gson.Gson;
import com.google.gson.reflect.TypeToken;
import java.lang.reflect.Type;
import java.util.List;
import static org.junit.jupiter.api.Assertions.*;

public class TodoApiTest {

    private static final String BASE_URL = "http://localhost:8000";

    @Test
    public void testGetAllTodos() throws Exception {
        // Arrange
        String url = BASE_URL + "/todos";
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
                .uri(new URI(url))
                .build();

        // Act
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

        // Assert
        assertEquals(200, response.statusCode());
        Gson gson = new Gson();
        Type todoListType = new TypeToken<List<Todo>>() {}.getType();
        List<Todo> todos = gson.fromJson(response.body(), todoListType);
        assertNotNull(todos);
        assertFalse(todos.isEmpty());
    }
}

text

TodoApiTest > testGetAllTodos() PASSED

TodoApiTest > testGetAllTodos() PASSED

Java

import org.junit.jupiter.api.*;
import java.net.http.HttpClient;

public class TodoApiTest {

    private static HttpClient client;

    @BeforeAll
    public static void setUpClass() {
        // Runs once before all tests
        client = HttpClient.newHttpClient();
    }

    @BeforeEach
    public void setUp() {
        // Runs before each test
        // You can initialize or reset test data here
    }

    @AfterEach
    public void tearDown() {
        // Runs after each test
        // Use this to clean up or reset state
    }

    @AfterAll
    public static void tearDownClass() {
        // Runs once after all tests
        // Clean up shared resources here
    }

    @Test
    public void testGetAllTodos() {
        // Test code here, using the shared 'client'
    }
}

import org.junit.jupiter.api.*;
import java.net.http.HttpClient;

public class TodoApiTest {

    private static HttpClient client;

    @BeforeAll
    public static void setUpClass() {
        // Runs once before all tests
        client = HttpClient.newHttpClient();
    }

    @BeforeEach
    public void setUp() {
        // Runs before each test
        // You can initialize or reset test data here
    }

    @AfterEach
    public void tearDown() {
        // Runs after each test
        // Use this to clean up or reset state
    }

    @AfterAll
    public static void tearDownClass() {
        // Runs once after all tests
        // Clean up shared resources here
    }

    @Test
    public void testGetAllTodos() {
        // Test code here, using the shared 'client'
    }
}

Java

import org.junit.jupiter.api.Test;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TodoApiTest {

    private static final String BASE_URL = "http://localhost:8000";

    @Test
    public void testGetAllTodos() throws Exception {
        // Arrange
        String url = BASE_URL + "/todos";
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
                .uri(new URI(url))
                .build();

Java

import org.junit.jupiter.api.Test;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TodoApiTest {

    private static final String BASE_URL = "http://localhost:8000";

    @Test
    public void testGetAllTodos() throws Exception {
        // Arrange
        String url = BASE_URL + "/todos";
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
                .uri(new URI(url))
                .build();

        // Act
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Java

import org.junit.jupiter.api.Test;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import com.google.gson.Gson;
import com.google.gson.reflect.TypeToken;
import java.lang.reflect.Type;
import java.util.List;
import static org.junit.jupiter.api.Assertions.*;

public class TodoApiTest {

    private static final String BASE_URL = "http://localhost:8000";

    @Test
    public void testGetAllTodos() throws Exception {
        // Arrange
        String url = BASE_URL + "/todos";
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
                .uri(new URI(url))
                .build();

        // Act
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

        // Assert
        assertEquals(200, response.statusCode());
        Gson gson = new Gson();
        Type todoListType = new TypeToken<List<Todo>>() {}.getType();
        List<Todo> todos = gson.fromJson(response.body(), todoListType);
        assertNotNull(todos);
        assertFalse(todos.isEmpty());
    }
}

text

TodoApiTest > testGetAllTodos() PASSED

Java

import org.junit.jupiter.api.*;
import java.net.http.HttpClient;

public class TodoApiTest {

    private static HttpClient client;

    @BeforeAll
    public static void setUpClass() {
        // Runs once before all tests
        client = HttpClient.newHttpClient();
    }

    @BeforeEach
    public void setUp() {
        // Runs before each test
        // You can initialize or reset test data here
    }

    @AfterEach
    public void tearDown() {
        // Runs after each test
        // Use this to clean up or reset state
    }

    @AfterAll
    public static void tearDownClass() {
        // Runs once after all tests
        // Clean up shared resources here
    }

    @Test
    public void testGetAllTodos() {
        // Test code here, using the shared 'client'
    }
}

Introduction to API Testing with Java

What is JUnit and How It Works

Arrange-Act-Assert (AAA) Pattern

Join the 1M+ learners on CodeSignal

Arranging the Test Function

Acting on the Test Case

Asserting the Expected Outcomes

Running Tests with JUnit

Understanding Fixtures in JUnit

Summary and Practice Preparation