Add custom headers to response after "render as JSON"

Question

I am trying to add a custom HTTP header to the response of a certain set of controllers using Grails Filters:

class ApiFilters {
   def filters = {
      xwingFilter(uri:'/api/**') {
         after = {
            response.setHeader('X-Wing', 'foo')
         }
      }
   }
}

If the controller renders a view or text, the header gets added to the response. If the controller uses "render as JSON" the header is not added. It looks like the JSON converter is closing the output stream and sending it right away. Is that right?

I could use Grails interceptors but I'd have to replicate it in more than one controller. Any ideas on how can I achieve this?

You could dynamically add the afterInterceptor to all controllers on startup (Bootstrap.groovy). — James Kleeh, Jun 04 '13 at 17:13
That could work. I think also having a base controller with the interceptor and extending from it. Thanks. — chozero, Jun 05 '13 at 10:50

score 5 · Accepted Answer · answered Jun 04 '13 at 15:05

You can do the translation from model to JSON in the filter instead of the action:

controller:

class myController {
    def myAction() {
        [aThing: 1, anotherThing: [a: 1, b: 2]]
    }
}

filter:

class ApiFilters {
    def filters = {
        xwingFilter(uri:'/api/**') {
            after = { model ->
                response.setHeader('X-Wing', 'foo')
                render model as JSON
                return false // prevent normal view from rendering
            }
        }
    }
}

Add custom headers to response after "render as JSON"

1 Answers1