[Django] RESTful API

Transcript

1. RESTful API Sébastien Fievet Journée au vert, EPFL, Lausanne CH 11 février 2011
2. “ ” What you REST is what you GET -- me
3. In the beginning...
4. In the beginning... There was django-piston
5. In the beginning... There was django-piston From BitBucket
6. In the beginning... There was django-piston From BitBucket With a rich set of features
7. Status
8. Status Last release v0.2.2 on June 2009
9. Status Last release v0.2.2 on June 2009 Last commit 5 months ago
10. Show me more
12. “ ” Creating delicious APIs for Django apps since 2010. -- Daniel Lindsley
13. django-tastypie
14. django-tastypie From the creator of haystack (Daniel Lindsley @daniellindsley)
15. django-tastypie From the creator of haystack (Daniel Lindsley @daniellindsley) Currently in beta (v0.9.5)
16. django-tastypie From the creator of haystack (Daniel Lindsley @daniellindsley) Currently in beta (v0.9.5) Already in production on several sites
17. Some features
18. Some features Speaks Django
19. Some features Speaks Django ModelResource vs Resource
20. Some features Speaks Django ModelResource vs Resource Resource discovery
21. Some features Speaks Django ModelResource vs Resource Resource discovery Pagination
22. Some features Speaks Django ModelResource vs Resource Resource discovery Pagination Deep relations
23. Getting started
24. from django.contrib.auth.models import User from tastypie import fields from tastypie.resources import ModelResource from blog.models import Entry class UserResource(ModelResource): class Meta: queryset = User.objects.all() resource_name = 'user' class EntryResource(ModelResource): user = fields.ForeignKey(UserResource, 'user') class Meta: queryset = Entry.objects.all() resource_name = 'entry'
25. Give me your URLs
27. http://127.0.0.1:8000/api/v1/?format=json
28. http://127.0.0.1:8000/api/v1/?format=json http://127.0.0.1:8000/api/v1/user/?format=json
29. http://127.0.0.1:8000/api/v1/?format=json http://127.0.0.1:8000/api/v1/user/?format=json http://127.0.0.1:8000/api/v1/user/1/?format=json
30. http://127.0.0.1:8000/api/v1/?format=json http://127.0.0.1:8000/api/v1/user/?format=json http://127.0.0.1:8000/api/v1/user/1/?format=json http://127.0.0.1:8000/api/v1/user/schema/?format=json
31. http://127.0.0.1:8000/api/v1/?format=json http://127.0.0.1:8000/api/v1/user/?format=json http://127.0.0.1:8000/api/v1/user/1/?format=json http://127.0.0.1:8000/api/v1/user/schema/?format=json http://127.0.0.1:8000/api/v1/user/set/1;3/?format=json
32. http://127.0.0.1:8000/api/v1/?format=json http://127.0.0.1:8000/api/v1/user/?format=json http://127.0.0.1:8000/api/v1/user/1/?format=json http://127.0.0.1:8000/api/v1/user/schema/?format=json http://127.0.0.1:8000/api/v1/user/set/1;3/?format=json http://127.0.0.1:8000/api/v1/entry/?format=json
33. http://127.0.0.1:8000/api/v1/?format=json http://127.0.0.1:8000/api/v1/user/?format=json http://127.0.0.1:8000/api/v1/user/1/?format=json http://127.0.0.1:8000/api/v1/user/schema/?format=json http://127.0.0.1:8000/api/v1/user/set/1;3/?format=json http://127.0.0.1:8000/api/v1/entry/?format=json http://127.0.0.1:8000/api/v1/entry/1/?format=json
34. http://127.0.0.1:8000/api/v1/?format=json http://127.0.0.1:8000/api/v1/user/?format=json http://127.0.0.1:8000/api/v1/user/1/?format=json http://127.0.0.1:8000/api/v1/user/schema/?format=json http://127.0.0.1:8000/api/v1/user/set/1;3/?format=json http://127.0.0.1:8000/api/v1/entry/?format=json http://127.0.0.1:8000/api/v1/entry/1/?format=json http://127.0.0.1:8000/api/v1/entry/schema/?format=json
35. http://127.0.0.1:8000/api/v1/?format=json http://127.0.0.1:8000/api/v1/user/?format=json http://127.0.0.1:8000/api/v1/user/1/?format=json http://127.0.0.1:8000/api/v1/user/schema/?format=json http://127.0.0.1:8000/api/v1/user/set/1;3/?format=json http://127.0.0.1:8000/api/v1/entry/?format=json http://127.0.0.1:8000/api/v1/entry/1/?format=json http://127.0.0.1:8000/api/v1/entry/schema/?format=json http://127.0.0.1:8000/api/v1/entry/set/1;3/?format=json
37. Do you speak HTTP ?
38. dj-webmachine
39. dj-webmachine From the creator of gunicorn (Benoit Chesneau @benoitc)
40. dj-webmachine From the creator of gunicorn (Benoit Chesneau @benoitc) Heavily inspired from webmachine
41. dj-webmachine From the creator of gunicorn (Benoit Chesneau @benoitc) Heavily inspired from webmachine Current version 0.2.1
42. Overview
43. Overview Speaks HTTP
44. Overview Speaks HTTP Autodiscover
45. Overview Speaks HTTP Autodiscover Routing (ala Flask)
46. Overview Speaks HTTP Autodiscover Routing (ala Flask) OAuth2
47. Getting started
48. from webmachine import Resource from webmachine.helpers.serialize import JSONSerializer class EntryResource(Resource): fields = None exclude = None def __init__(self): self.json = JSONSerializer(fields=self.fields, exclude=self.exclude) super(BaseResource, self).__init__() def content_types_provided(self, request, response): return ( ('application/json', self.to_json), ) def allowed_methods(self, request, response): return ('GET', ) def get_query_set(self): return Entry.objects.all() def to_json(self, request, response): return self.json.serialize(self.get_query_set())
50. Hook it up
51. Hook it up Adding format-suffixed resource
52. Hook it up Adding format-suffixed resource http://awesome.com/api/resource.json
53. django-tastypie
54. from django.conf.urls.defaults import url from tastypie.resources import ModelResource class SuffixedResource(ModelResource): class Meta: allowed_methods = ('get', ) def determine_format(self, request): url_parts = request.path.rsplit(".", 1) try: format = url_parts[1] if format in self._meta.serializer.formats: return self._meta.serializer.get_mime_for_format(format) except IndexError: pass return super(SuffixedResource, self).determine_format(request) def format_suffix(self): return r'\.(%s)' % '|'.join(self._meta.serializer.formats) def override_urls(self): # def base_urls(self): return [ url(r"^(?P<resource_name>%s)%s$" % (self._meta.resource_name, self.format_suffix()), self.wrap_view('dispatch_list'), name="api_dispatch_list"), url(r"^(?P<resource_name>%s)/schema%s$" % (self._meta.resource_name, self.format_suffix()), self.wrap_view('get_schema'), name="api_get_schema"), url(r"^(?P<resource_name>%s)/(?P<pk>\w[\w/-]*)%s$" % (self._meta.resource_name, self.format_suffix()), self.wrap_view('dispatch_detail'), name="api_dispatch_detail"), ]
55. dj-webmachine
56. from django.conf.urls.defaults import patterns, url from webmachine import Resource class SuffixedResource(Resource): def content_types_provided(self, request, response): return ( ('application/json', self.to_json), ) def format_suffix_accepted(self, request, response): return ( ("json", "application/json"), ) def allowed_methods(self, request, response): return ('GET', ) def get_urls(self): regexp = getattr(self, "url_regexp") or r'^$' # Add format suffix formats = dict(self.format_suffix_accepted(None, None)) regexp = regexp[:-1] + r'(.%s)?' % '|'.join(formats.keys()) + regexp[-1] # -- urlpatterns = patterns('', url(regexp, self, name="%s_index" % self.__class__.__name__), ) return urlpatterns
57. Recap:
58. Recap: You have the choice
59. Recap: You have the choice Choosing a backend is a trade-off
60. Recap: You have the choice Choosing a backend is a trade-off Fork it, toy it, contribute it
61. More information django-piston (https://bitbucket.org/ jespern/django-piston/) django-tastypie (http:// toastdriven.github.com/django-tastypie/ Django Pluggables: http:// djangoplugables.com/
62. Questions?
63. Thank you for listening
64. Credits James Bennet (http://www.b-list.org/ weblog/2008/sep/07/slides/) License: Creative Commons