Mojolicious and REST
4 likes3,762 views
This document discusses building RESTful interfaces using the Mojolicious framework in Perl. It notes that implementing REST with Mojolicious is easy, but can lead to an anti-pattern of encoding media types in URLs instead of using accept headers. The recommended practice is to use accept headers to specify media types rather than encoding them in the URL. The document provides an example of using Mojolicious to respond with different media types depending on the accept header.
![$self->respond_to(
json => { status => $status, json => $response },
text => { status => $status, text => $message },
xml => {
status => $status,
text
=> XMLout(
$response,
NoAttr
=> TRUE,
RootName => XML_ROOT,
keyattr => [],
XMLDecl => XML_DECL
)
},
any => {
status => HTTP_UNSUPPORTED_MEDIA_TYPE,
json
=> status_message(HTTP_UNSUPPORTED_MEDIA_TYPE)
},
);](https://image.slidesharecdn.com/mojolicious-and-rest-131124110728-phpapp02/85/Mojolicious-and-REST-10-320.jpg)
Mojolicious and REST
- 1. Mojolicious and REST Building a RESTful interface using Mojolicious By @jonasbn for Nordic Perl Workshop 2013
- 3. • Implementing REST using Mojolicious is easy • very easy • too easy
- 4. but!
- 5. Rest in Practice Ian Robinson, Jim Webber and Savas Parastatides • On mediatypes, describes an antipattern implemented in Ruby on Rails
- 6. • • • On mediatypes, describes an anti-pattern implemented in Ruby on Rails (RoR) This pattern has unfortunately made it to Mojolicious and that is to have the mediatype communicated on the URL
- 7. so?
- 8. • The recommended practice is to use Accept headers to communicate media-types • and these can be weighted 8-o • We use HTTP status codes to communicate state and status • URLs should be used to communicate intent not formatting • For Mojolicious this required some experimenting
- 9. code?
- 10. $self->respond_to( json => { status => $status, json => $response }, text => { status => $status, text => $message }, xml => { status => $status, text => XMLout( $response, NoAttr => TRUE, RootName => XML_ROOT, keyattr => [], XMLDecl => XML_DECL ) }, any => { status => HTTP_UNSUPPORTED_MEDIA_TYPE, json => status_message(HTTP_UNSUPPORTED_MEDIA_TYPE) }, );
- 11. Lessons Learned • Mojolicious does the right thing when it comes to the Accept header and actually does it quite well • The anti-pattern supported by Mojolicious can be avoided • Use # instead of : in your routes (see the diff) and it will work • But actually ?format=(json|text|xml) is supported but we only use it for debugging (and it actually has precedence (and it is undocumented on our side))