Skip to main content

Java

Java is a statically typed, object-oriented programming language renowned for its portability, performance, and scalability. It is commonly used in enterprise and Android development.

tip

Java is ideal for building robust, scalable APIs, often using frameworks like Spring Boot. It is also widely used in Android apps to consume APIs, making it an integral part of mobile development.

Let's make a POST request to a hypothetical API endpoint, https://api.example.com/resource, to send JSON data using Java.

Prerequisites​

Before making API calls with Java, ensure you:

  1. Have Java Development Kit (JDK) installed.
  2. Use a build tool like Maven or Gradle for dependency management.
  3. Add the java.net.http package (available from Java 11 onward) or include a library like Apache HttpClient if using an earlier version.

Request​

We’ll use Java’s HttpClient (introduced in Java 11) to send a POST request with JSON data.

Example
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class ApiExample {
    public static void main(String[] args) {
        // Define the API endpoint
        String url = "https://api.example.com/resource";

        // Create the JSON payload
        String jsonPayload = """
                {
                    \"name\": \"John Doe\",
                    \"email\": \"johndoe@example.com\",
                    \"age\": 30
                }
                """;

        // Create the HttpClient
        HttpClient client = HttpClient.newHttpClient();

        // Create the HttpRequest
        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create(url))
                .header("Content-Type", "application/json")
                .POST(HttpRequest.BodyPublishers.ofString(jsonPayload))
                .build();

        try {
            // Send the POST request and get the response
            HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

            // Output the response
            System.out.println("Response Code: " + response.statusCode());
            System.out.println("Response Body: " + response.body());
        } catch (Exception e) {
            System.err.println("An error occurred: " + e.getMessage());
        }
    }
}

How it works​

  1. API Endpoint: The url variable holds the endpoint URL.
  2. Request Data: The jsonPayload string contains the JSON data to send.
  3. HttpClient: The HttpClient is responsible for sending the HTTP request.
  4. HttpRequest: The HttpRequest object specifies the URL, headers, and body of the request.
  5. Response Handling: The HttpResponse object contains the status code and body of the response.

Response​

If the API successfully processes the request, it might return a JSON response like:

{
    "status": "success",
    "message": "Data received successfully",
    "id": "12345"
}

This response will be printed to the console.

Adding authentication​

If the API requires authentication, include it in the request:

  • Basic Authentication:

    String auth = Base64.getEncoder().encodeToString("username:password".getBytes());
    HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create(url))
            .header("Content-Type", "application/json")
            .header("Authorization", "Basic " + auth)
            .POST(HttpRequest.BodyPublishers.ofString(jsonPayload))
            .build();

  • Bearer Token:

    HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create(url))
            .header("Content-Type", "application/json")
            .header("Authorization", "Bearer YOUR_TOKEN_HERE")
            .POST(HttpRequest.BodyPublishers.ofString(jsonPayload))
            .build();

Saving the response​

To save the API’s response to a file:

import java.nio.file.Files;
import java.nio.file.Path;

Files.writeString(Path.of("response.json"), response.body());

Tips for using Java with APIs​

  • Error Handling: Wrap your request logic in try-catch blocks to handle exceptions like IOException and InterruptedException.
  • Timeouts: Configure timeouts using HttpClient.Builder:
    HttpClient client = HttpClient.newBuilder()
            .connectTimeout(Duration.ofSeconds(10))
            .build();
  • Reusable Methods: Encapsulate HTTP request logic in reusable methods for cleaner and more maintainable code.

With these basics, you can confidently use Java to interact with APIs!