18.4.1. Using JAX-RS (Java API for RESTful Web Services)

JAX-RS is the standard API for creating RESTful services in Java EE.

JAX-RS, which stands for Java API for RESTful Web Services, provides a set of APIs to create web services in a way that adheres to REST principles. Java EE developers commonly use this framework as it aligns well with the architecture and design of enterprise applications, allowing for the seamless development of robust RESTful services.

Think of JAX-RS like a toolbox specifically designed for craftspersons building furniture. Just as a toolbox provides the right tools to create a chair or a table efficiently, JAX-RS provides developers with the necessary tools to build web services that are efficient and effective.

<dependency>
<groupId>javax.ws.rs</groupId>
<artifactId>javax.ws.rs-api</artifactId>
<version>2.1</version>
</dependency>

To use JAX-RS in a Java EE application, you need to include the relevant dependencies in your project. This snippet specifies that you are including the JAX-RS API with version 2.1 in your Maven project. By adding this dependency to your pom.xml file, Maven will automatically download the necessary libraries, making class and method calls available for use in your code.

Consider this step like getting the ingredients ready before baking a cake. Just as you gather flour, eggs, and sugar to prepare for baking, adding dependencies to your project ensures you have all the necessary components to build your RESTful services.

@Path("/employees")
public class EmployeeResource {
private static List<Employee> employees = new ArrayList<>();
@GET
@Produces(MediaType.APPLICATION_JSON)
public List<Employee> getEmployees() {
return employees;
}
@POST
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
public Employee addEmployee(Employee employee) {
employees.add(employee);
return employee;
}
@PUT
@Path("/{id}")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
public Employee updateEmployee(@PathParam("id") int id, Employee employee) {
for (Employee e : employees) {
if (e.getId() == id) {
e.setName(employee.getName());
e.setDepartment(employee.getDepartment());
return e;
}
}
return null;
}
@DELETE
@Path("/{id}")
public String deleteEmployee(@PathParam("id") int id) {
employees.removeIf(e -> e.getId() == id);
return "Employee deleted.";
}
}

This code snippet demonstrates how to create a REST resource for managing employee data using JAX-RS. The EmployeeResource class is annotated with @Path("/employees"), indicating that it handles requests to the /employees endpoint. The class provides methods for various HTTP methods: GET for retrieving employee data, POST for adding a new employee, PUT for updating existing employee data, and DELETE for removing an employee.

Imagine running a library where each shelf holds different books. Just like each shelf has its own space and collection of books, each method in your REST resource acts as a specific function—helping you get, add, update, or remove a book from the library. This organization makes it easy for anyone to find the book they want!

--