Jackson Support

The WebServer supports Jackson. When this support is enabled, Java objects will be serialized to and deserialized from JSON automatically using Jackson.

Maven Coordinates

Declare the following dependency in your project:

<dependency>
    <groupId>io.helidon.media.jackson</groupId>
    <artifactId>helidon-media-jackson-server</artifactId>
</dependency>
Copied

Usage

To enable Jackson support, first create and register a JacksonSupport instance with a Routing.Builder. JacksonSupport is a Service, so it will install its own Handler that will provide serialization and deserialization services using Jackson.

Create and register JacksonSupport first
final JacksonSupport jacksonSupport = JacksonSupport.create(); 
final Routing.Builder routingBuilder = Routing.builder();
routingBuilder.register(jacksonSupport); 
Copied
  • Create a JacksonSupport instance. This instance may be reused freely.
  • Register that JacksonSupport instance to enable automatic deserialization of Java objects from and serialization of Java objects to JSON.

Now that automatic JSON serialization and deserialization facilities have been set up, you can register a Handler that works with Java objects instead of raw JSON. Deserialization from and serialization to JSON will be handled by Jackson.

Suppose you have a Person class that looks like this:

Hypothetical Person class
public class Person {

    private String name;

    public Person() {
        super();
    }

    public String getName() {
        return this.name;
    }

    public void setName(final String name) {
        this.name = name;
    }
}
Copied

Then you can set up a Handler like this:

A Handler that works with Java objects instead of raw JSON
final Routing routing =
    routingBuilder.post("/echo", 
                        Handler.create(Person.class, 
                                       (req, res, person) -> res.send(person)))) 
    .build();
Copied
Example of posting JSON to the /echo endpoint
curl --noproxy '*' -X POST -H "Content-Type: application/json" \
    http://localhost:8080/echo -d '{"name":"Joe"}'
{"name":"Joe"}
Copied