Introduction to Django REST Framework, an easy way to build REST framework in Django
7 likes2,879 views
The document provides an overview of using the Django Rest Framework for building REST APIs, highlighting essential features such as serialization, authentication, and performance. It includes a minimal example of API implementation with model and view definitions and emphasizes the framework's design and documentation quality. Additionally, it addresses the need to update to Django 1.4.11 or higher and outlines testing and documentation resources.
Introduction to Django REST Framework, an easy way to build REST framework in Django
- 2. ● developer@keycrunch & founder@offerqa ● built REST api in Django since 2013 follow me on twitter @linuxcity who am I?
- 3. What is REST? http://en.wikipedia.org/wiki/Representational_State_Transfer Web API that uses GET, POST, PUT, PATCH, DELETE operations over HTTP.
- 4. What do you need from a framework ● serialization and deserialization ● pagination ● data validation ● authentication ● custom queryset ● proper HTTP response handling (errors, format and such) ● caching ● throttling ● permissions
- 5. Good to have ● Really good test coverage of their code ● Decent performance ● Documentation ● An active community to advance and support the framework
- 6. And Django REST Framework has them all!!!
- 7. Why Django REST framework ● Class-based views ● it’s very django-ish ...As it's based off Django 1.3 style Class Based Views (CBVs), it has a very familiar pattern. Actually, because of the quality of the documentation, I really prefer using django-rest-framework CBVs more than using Django's actual CBVs… -from http://pydanny.com/choosing-an-api-framework-for-django.html ● neat design ...
- 8. And Most of All I enjoyed working with it
- 9. Requirement Django >1.4.11 so if you are still on Django 1.3, it’s time to update. And you should have done that three years ago!
- 10. a minimal REST API models.py class Post(models.Model): post = models.TextField() class PostSerializer(serializers.HyperlinkedModelSerializer): class Meta: model = Post
- 11. a minimal REST API views.py class PostViewSet(viewsets.ModelViewSet): queryset = Post.objects.all() serializer_class = PostSerializer
- 12. a minimal REST API urls.py router = routers.SimpleRouter() router.register(r'posts', views.PostViewSet) urlpatterns = patterns('', url(r'^', include(router.urls)), ….
- 13. a minimal REST API This project can be found at: https://github.com/zheli/django-rest-kog tag: v1
- 15. serializer serializing: querysets, model instances->python native datatypes deserializing: data string->model instances
- 16. serializer automatic serializers from model: ModelSerializer, HyperlinkedModelSerializer
- 17. views automatic views from model: ModelViewSets: CRUD + list ReadOnlyModelViewSet: retrieve + list
- 18. test APIRequestFactory() from RequestFactory APIClient() from Client Test POST request: class PostTests(APITestCase): ←- self.client == APIClient() def test_create_post(self): response = self.client.post(‘/posts/’, {‘post’: ‘this is a test post’}, format=’json’) self.assertEqual(response.status_code, status.HTTP_201_CREATED) assert response.data is not None
- 20. documentation
- 22. documentation