Fork me on GitHub

Dropwizard Views

The dropwizard-views module provides you with simple, fast HTML views using either FreeMarker or Mustache.

To enable views for your service, add the ViewBundle in the initialize method of your Service class:

public void initialize(Bootstrap<MyConfiguration> bootstrap) {
    bootstrap.addBundle(new ViewBundle());

Then, in your resource method, add a View class:

public class PersonView extends View {
    private final Person person;

    public PersonView(Person person) {
        this.person = person;

    public Person getPerson() {
        return person;

person.ftl is the path of the template relative to the class name. If this class was com.example.service.PersonView, Dropwizard would then look for the file src/main/resources/com/example/service/person.ftl.

If your template ends with .ftl, it’ll be interpreted as a FreeMarker template. If it ends with .mustache, it’ll be interpreted as a Mustache template.


Dropwizard Views also support localized template files. It picks up the client’s locale from their Accept-Language, so you can add a French template in person_fr.ftl or a Canadian template in person_en_CA.ftl.

Your template file might look something like this:

<#-- @ftlvariable name="" type="com.example.views.PersonView" -->
        <!-- calls getPerson().getName() and sanitizes it -->
        <h1>Hello, ${}!</h1>

The @ftlvariable lets FreeMarker (and any FreeMarker IDE plugins you may be using) know that the root object is a com.example.views.PersonView instance. If you attempt to call a property which doesn’t exist on PersonViewgetConnectionPool(), for example – it will flag that line in your IDE.

Once you have your view and template, you can simply return an instance of your View subclass:

public class PersonResource {
    private final PersonDAO dao;

    public PersonResource(PersonDAO dao) {
        this.dao = dao;

    public PersonView getPerson(@PathParam("id") String id) {
        return new PersonView(dao.find(id));


Jackson can also serialize your views, allowing you to serve both text/html and application/json with a single representation class.

For more information on how to use FreeMarker, see the FreeMarker documentation.

For more information on how to use Mustache, see the Mustache and documentation.