Understanding Path and Query Parameters in Java Using HttpClient and Gson

Introduction to Path and Query Parameters

Welcome to another lesson of this course. In our previous lessons, we established a foundation by learning about RESTful APIs and making GET requests using Java's HttpClient and Gson library. Now, we will shift our focus to path and query parameters, essential tools for refining API requests and fetching specific data. Path and query parameters play a crucial role in making your API requests more precise and efficient. Imagine you are shopping online: selecting a specific item using its ID is akin to a path parameter, while filtering items by categories like price or color resembles query parameters. In this lesson, we'll explore these concepts with practical examples, empowering you to extract just the information you need from an API.

Understanding Path Parameters

Path parameters are part of the URL used to access specific resources within an API, acting like unique identifiers. For example, if you want to retrieve a to-do item with ID 3, the URL would be structured as follows: text http://localhost:8000/todos/3 http://localhost:8000/todos/3 In this case, 3 is the path parameter specifying the particular item you wish to access.

Understanding Query Parameters

Query parameters are added to the URL after a ? to filter or modify the data returned by the API. They are formatted as key-value pairs. For instance, if you want to list only the completed to-do tasks, your request would be: text http://localhost:8000/todos?done=true http://localhost:8000/todos?done=true Here, done=true is the query parameter filtering the results to include only tasks that are marked as completed.

Setup Recap

Before jumping into implementing these parameters using Java's HttpClient and Gson, let's make sure everything's set up. Start by importing the necessary Java classes and defining the base URL: Java import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; import java.net.URI; import com.google.gson.Gson; // Initialize HttpClient HttpClient client = HttpClient.newHttpClient(); // Base URL for the API String baseUrl = "http://localhost:8000"; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; import java.net.URI; import com.google.gson.Gson; // Initialize HttpClient HttpClient client = HttpClient.newHttpClient(); // Base URL for the API String baseUrl = "http://localhost:8000"; Now we're all set to dive into the code examples!

Fetching Data with Path Parameters

Join the 1M+ learners on CodeSignal

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

text

http://localhost:8000/todos/3

text

http://localhost:8000/todos?done=true

Java

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import com.google.gson.Gson;

// Initialize HttpClient
HttpClient client = HttpClient.newHttpClient();

// Base URL for the API
String baseUrl = "http://localhost:8000";

Java

// Define the ID of the todo item you want to retrieve
int todoId = 3;

// Create the HTTP GET request using the path parameter for the specific todo item
HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create(baseUrl + "/todos/" + todoId))
        .GET()
        .build();

// Send the request and get the response
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
Gson gson = new Gson();
Todo todo = gson.fromJson(response.body(), Todo.class);

// Print all details of the todo item
System.out.println("ID: " + todo.id);
System.out.println("Title: " + todo.title);
System.out.println("Description: " + todo.description);
System.out.println("Done: " + todo.done);

// Define the ID of the todo item you want to retrieve
int todoId = 3;

// Create the HTTP GET request using the path parameter for the specific todo item
HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create(baseUrl + "/todos/" + todoId))
        .GET()
        .build();

// Send the request and get the response
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
Gson gson = new Gson();
Todo todo = gson.fromJson(response.body(), Todo.class);

// Print all details of the todo item
System.out.println("ID: " + todo.id);
System.out.println("Title: " + todo.title);
System.out.println("Description: " + todo.description);
System.out.println("Done: " + todo.done);

Java

// Create the HTTP GET request with a query parameter to filter for completed tasks
HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create(baseUrl + "/todos?done=true"))
        .GET()
        .build();

// Send the request and get the response

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
Gson gson = new Gson();
Type todoListType = new TypeToken<List<Todo>>() {}.getType();
List<Todo> todos = gson.fromJson(response.body(), todoListType);

// Print the todo items
for (Todo todo : todos) {
System.out.println("- " + todo.id + ": " + todo.title);
}

// Create the HTTP GET request with a query parameter to filter for completed tasks
HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create(baseUrl + "/todos?done=true"))
        .GET()
        .build();

// Send the request and get the response

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
Gson gson = new Gson();
Type todoListType = new TypeToken<List<Todo>>() {}.getType();
List<Todo> todos = gson.fromJson(response.body(), todoListType);

// Print the todo items
for (Todo todo : todos) {
System.out.println("- " + todo.id + ": " + todo.title);
}

Java

// Define the multiple query parameters
String params = "done=true&title=c";

// Create the HTTP GET request with multiple query parameters
HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create(baseUrl + "/todos?" + params))
        .GET()
        .build();

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

Gson gson = new Gson();
Type todoListType = new TypeToken<List<Todo>>() {}.getType();
List<Todo> todos = gson.fromJson(response.body(), todoListType);

// Print the filtered todo items
for (Todo todo : todos) {
System.out.println("- " + todo.get("id").getAsInt() + ": " + todo.get("title").getAsString());
}

// Define the multiple query parameters
String params = "done=true&title=c";

// Create the HTTP GET request with multiple query parameters
HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create(baseUrl + "/todos?" + params))
        .GET()
        .build();

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

Gson gson = new Gson();
Type todoListType = new TypeToken<List<Todo>>() {}.getType();
List<Todo> todos = gson.fromJson(response.body(), todoListType);

// Print the filtered todo items
for (Todo todo : todos) {
System.out.println("- " + todo.get("id").getAsInt() + ": " + todo.get("title").getAsString());
}

Java

// Define the ID of the todo item you want to retrieve
int todoId = 3;

// Create the HTTP GET request using the path parameter for the specific todo item
HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create(baseUrl + "/todos/" + todoId))
        .GET()
        .build();

// Send the request and get the response
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
Gson gson = new Gson();
Todo todo = gson.fromJson(response.body(), Todo.class);

// Print all details of the todo item
System.out.println("ID: " + todo.id);
System.out.println("Title: " + todo.title);
System.out.println("Description: " + todo.description);
System.out.println("Done: " + todo.done);

Java

// Create the HTTP GET request with a query parameter to filter for completed tasks
HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create(baseUrl + "/todos?done=true"))
        .GET()
        .build();

// Send the request and get the response

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
Gson gson = new Gson();
Type todoListType = new TypeToken<List<Todo>>() {}.getType();
List<Todo> todos = gson.fromJson(response.body(), todoListType);

// Print the todo items
for (Todo todo : todos) {
System.out.println("- " + todo.id + ": " + todo.title);
}

Java

// Define the multiple query parameters
String params = "done=true&title=c";

// Create the HTTP GET request with multiple query parameters
HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create(baseUrl + "/todos?" + params))
        .GET()
        .build();

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

Gson gson = new Gson();
Type todoListType = new TypeToken<List<Todo>>() {}.getType();
List<Todo> todos = gson.fromJson(response.body(), todoListType);

// Print the filtered todo items
for (Todo todo : todos) {
System.out.println("- " + todo.get("id").getAsInt() + ": " + todo.get("title").getAsString());
}

Introduction to Path and Query Parameters

Understanding Path Parameters

Understanding Query Parameters

Setup Recap

Fetching Data with Path Parameters

Join the 1M+ learners on CodeSignal

Filtering Data with Query Parameters

Using Multiple Query Parameters

Summary and Preparing for Practice