Pretty Print JSON Per Request With Spring MVC

You will find a lot of posts and stackoverflow answers telling you how to pretty-print JSON responses. But sometimes you may need to tune the “prettiness” per request.

The use case for this is when you are using tools like curl or RESTClient to interact with the system and you want human-readable output. Of course, if you need human-readable output only for debug purposes, you should really consider whether you need JSON at all, or you should use some binary format. But let’s assume you need JSON. And that you’d rather get it pretty-printed, rather than use an external tool to prettify it afterwards.

The basic idea is to enable pretty-printing with either a GET parameter, or preferably with an Accept header like application/json+pretty. With Spring MVC that is not supported out of the box. You’d need to create a class like that:

/**
 * An subclass of the MappingJackson2HttpMessageConverter that accespts the application/json+pretty content type
 * in order to enable per-request prettified JSON responses
 *  
 * @author bozho
 *
 */
public class PrettyMappingJackson2HttpMessageConverter extends MappingJackson2HttpMessageConverter {

  /**
   * Construct a new {@link MappingJackson2HttpMessageConverter} using default configuration
   * provided by {@link Jackson2ObjectMapperBuilder}
   */
  public PrettyMappingJackson2HttpMessageConverter() {
    super();
    objectMapper.enable(SerializationFeature.INDENT_OUTPUT);
    setSupportedMediaTypes(Lists.newArrayList(new MediaType("application", "json+pretty", DEFAULT_CHARSET)));
  }
}

Then in your spring-mvc xml configuraton (or java config counterpart) you should register this as a message converter:

<mvc:message-converters>
    <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter" />
    <!-- Handling Accept: application/json+pretty -->
    <bean class="com.yourproject.util.PrettyMappingJackson2HttpMessageConverter" />
</mvc:message-converters>

If you have a separately defined ObjectMapper and want to pass it to the pretty converter, you should override the other constructor (accepting an object mapper), and use the .copy() method before enabling the INDENT_OUTPUT.

And then you’re done. You can switch from regular (non-indented) and pretty output by setting the Accept header to application/json+pretty