#60 ✓resolved
Erwan Loisant

Documentation: Add section about content negotiation

Reported by Erwan Loisant | October 5th, 2010 @ 11:56 AM | in 1.1

It would be great if the routes or controller documentation would shortly describe how to make use of the content negotiation provided by Play! framework (and discuss the format fallback strategy).

Related Google Groups Thread: http://groups.google.com/group/play-framework/browse_thread/thread/...

Guillaume Bort (27 Okt. 2009, 16:40)

In fact if the Accept header is not suitable for you, you can even use
different URL path. For example, in conf/routes:
GET /index Application.index
GET /index.xml Application.index(format:'xml')
You can even extract the format information, dynamically from the URL path
GET /index.{format} Application.index

Guillaume Bort (27 Okt. 2009, 16:55)

Currently the only content type resolved by the engine itself are only
txt,html,json and xml.
But I agree it's lame, and surely it should be pluggable.
However you can easily do it yourself either by specifying the correct
format value for a special URL in the route file, or using a @Before
interceptor that examine the Accept header:

@Before
static void setFormat() { 
    if(request.headers.get("accept").value().equals("text/v-card")) { 
        request.format = "vcf"; 
    } 
}

And it will finally render the index.vcf template and set
automatically response mime-type to text/v-card.

Imported from Launchpad: https://bugs.launchpad.net/play/+bug/605369

Comments and changes to this ticket

Please Sign in or create a free account to add a new ticket.

With your very own profile, you can contribute to projects, track your activity, watch tickets, receive and update tickets through your email and much more.

New-ticket Create new ticket

Create your profile

Help contribute to this project by taking a few moments to create your personal profile. Create your profile »

<h2>Play framework</h2>

Play makes it easier to build Web applications with Java. It is a clean alternative to bloated Enterprise Java stacks. It focuses on developer productivity and targets RESTful architectures. Learn more on the <a href="http://www.playframework.org">http://www.playframework.org</a> website.<br><br>

<h2>Source code is hosted on github</h2>Check out our repository at <a href="http://github.com/playframework/play">http://github.com/playframework/play</a><br><br>

<h2>Contributing, creating a patch</h2> Please read the <a href="http://play.lighthouseapp.com/projects/57987/contributor-guide">contributor guide</a><br><br>

<h2>Reporting Security Vulnerabilities</h2> Since all bug reports are public, please report any security vulnerability directly to <em>guillaume dot bort at gmail dot com</em>.<br><br>

<h2>Creating a bug report</h2> Bug reports are incredibly helpful, so take time to report bugs and request features in our ticket tracker. We’re always grateful for patches to Play’s code. Indeed, bug reports with attached patches will get fixed far quickly than those without any.<br><br>

Please include as much relevant information as possible including the exact framework version you're using and a code snippet that reproduces the problem.<br><br>

Don't have too much expectations. Unless the bug is really a serious "everything is broken" thing, you're creating a ticket to start a discussion. Having a patch (or a branch on Github we can pull from) is better, but then again we'll only pull high quality branches that make sense to be in the core of Play.

People watching this ticket

Pages