Atelier sur django-tastypie

Atelier basé sur le projet omgcats (une simple galerie de photo) en django, pour en faire une API REST

Transcript

1. Omgcats – Atelier django Comment bien débuter et développer un projet django
2. Qui suis-je Benoit `dzen’ Calvez Developpeur python/django depuis pas mal de mois / années Vineolia.fr, medici.tv, litchis.org (ahaha), inventeev.com, ebookgarage.com, autolib.eu (en cours), linkuist.com (full lulz),
3. Programme du jour Tour d’horizons des solutions Démarrer son API Aller plus loin
4. Resources Un projet sur github Suivre le tuto pas à pas $> git clone https://github.com/dzen/omgcats $> git checkout feature/rest_api $> git checkout <hash>
5. Evolution du REST
6. Avant: django-piston Développé par Jesper Noher Dispo sur bitbucket Pour bitbucket Beaucoup de contribs (trop ?) Beaucoup de bugs (trop ?)
7. Puis: django-rest-framework Developpé par Tom Christie Classy, Object (trop ?), Générique Limité (pas de pagination, pas de many to many, sérialisation lente)
8. Maintenant: django-tastypie Développé par/chez toast driven Générique All battery included Avenir inconnu
9. Oui, mais après Django-rest-framework 2.0 http://django-rest-framework.org/topics/rest-framework-2-announcement.html Django-tastypie (vive l’opensource)
10. Atelier time
11. Atelier time Installation Configuration du projet $> pip install django-tastypie INSTALLED_APPS += (‘tastypie’)
12. Intégration avec l’existant Deux resources: « gallery » et « Image » from tastypie.resources import ModelResource from omgcats import models class GalleryResource(ModelResource): class Meta: queryset = models.Gallery.objects.all() resource_name = 'gallery'
13. Resources accessibles Créer des urls pour nos resources urlpatterns = patterns('', (r'^api/gallery/', include(GalleryResource().urls)) (r'^api/image/', include(ImageResource().urls)) )
14. Identification / Authorisation Deux notions différentes: Identifier V.S. Droit d’accès Session django, Oauth, Digest, Basic, ApiKey class GalleryResource(ModelResource): class Meta: authentication = MultiAuthentication( ApiKeyAuthentication(), SessionAuthentication()) authorization = ( Authorization() )
15. Relations Les relations sont explicites Utilisation des fields comme à des forms ou modèles classiques from tastypie import fields images = fields.ToManyField(ImageResource, 'images', full=True)
16. Modification de resource Verbes HTTP POST: Créer une resource PUT: Remplacer une resource (par une autre) $> curl --dump-header - -H "Content-Type: application/json" -X POST -- data '{"name": "APi modified gallery", "Description": "My funky description"}' http://localhost:8000/api/1.0/gallery/2/\?username\=benoit \&api_key\=1d4242 $> curl --dump-header - -H "Content-Type: application/json" -X PUT -- data '{"name": "APi modified gallery", "Description": "My funky description"}' http://localhost:8000/api/1.0/gallery/2/\?username\=benoit \&api_key\=1d4242
17. Tests Utilisation de Factory Boy (maintenir des fixtures, c’est relou) No factories $> pip install factory_boy
18. Pourquoi avoir fait tout ça ?
19. Mais aussi „Apps to services“ https://speakerdeck.com/craigkerstiens/djangocong-apps-to-services
20. Avez vous des questions?