Download as PDF, PPTX
Uploaded byZhe Li
Introduction to Django REST Framework, an easy way to build REST framework in Django
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.
In this document
Powered by AI
The speaker introduces himself as a developer and founder, with experience in building REST APIs using Django since 2013.
Introduction to REST, explaining it as a web API that utilizes HTTP methods like GET, POST, PUT, DELETE.
Outlines essential and desirable features for a framework to build REST APIs, such as serialization, validation, documentation, and community support.
Django REST framework meets all necessary requirements, offers a familiar design, and the speaker enjoys working with it.
Emphasizes the importance of using Django version greater than 1.4.11 for compatibility with the REST framework.
Example of creating a model for a post in Django, including a serializer for the model.
Demonstration of setting up viewsets in Django for the Post model to handle CRUD operations.
Configuration of URL routing in Django to include the newly created REST API endpoints.
Links to the GitHub project repository containing the minimal REST API project.
Highlights key components in building a REST API: serializers and views.
Explains the process of serializing and deserializing data with serializers in Django REST framework.
Describes how to use automatic views from models like ModelViewSets and ReadOnlyModelViewSet.
Introduction to testing REST APIs using APIRequestFactory and APIClient in Django.
Discusses available documentation tools like Django REST Swagger and REST Framework Docs for API documentation.
More Related Content
Similar to Introduction to Django REST Framework, an easy way to build REST framework in Django
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 WebAPI that uses GET, POST, PUT, PATCH, DELETE operations over HTTP.
- 4. What do youneed 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 RESTFramework has them all!!!
- 7. Why Django RESTframework ● 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 ofAll I enjoyed working with it
- 9. Requirement Django >1.4.11 so ifyou are still on Django 1.3, it’s time to update. And you should have done that three years ago!
- 10. a minimal RESTAPI models.py class Post(models.Model): post = models.TextField() class PostSerializer(serializers.HyperlinkedModelSerializer): class Meta: model = Post
- 11. a minimal RESTAPI views.py class PostViewSet(viewsets.ModelViewSet): queryset = Post.objects.all() serializer_class = PostSerializer
- 12. a minimal RESTAPI urls.py router = routers.SimpleRouter() router.register(r'posts', views.PostViewSet) urlpatterns = patterns('', url(r'^', include(router.urls)), ….
- 13. a minimal RESTAPI This project can be found at: https://github.com/zheli/django-rest-kog tag: v1
- 14.
- 15. serializer serializing: querysets, model instances->pythonnative datatypes deserializing: data string->model instances
- 16. serializer automatic serializers frommodel: ModelSerializer, HyperlinkedModelSerializer
- 17. views automatic views frommodel: 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
- 19.
- 20.
- 21.
- 22.
- 23.