Django REST framework

https://www.django-rest-framework.org/tutorial/quickstart/#quickstart

Django REST framework is a powerful and flexible toolkit for building Web APIs.

Quickstart

Based on https://www.django-rest-framework.org/tutorial/quickstart/#quickstart

   1 cd ~/tmp
   2 mkdir django-rest-test
   3 cd django-rest-test
   4 sudo apt install python3-venv
   5 python3 -m venv virtenv
   6 . virtenv/bin/activate
   7 pip install djangorestframework
   8 find . virtenv/
   9 django-admin startproject tutorial . 
  10 cd tutorial
  11 django-admin startapp quickstart
  12 cd ..
  13 python manage.py migrate # sync DB 
  14 python manage.py createsuperuser --email admin@example.com --username admin # create super user, pwd: 12345678 
  15 nano tutorial/quickstart/serializers.py
  16 nano tutorial/quickstart/views.py
  17 nano tutorial/urls.py
  18 nano tutorial/settings.py
  19 python manage.py runserver
  20 # Starting development server at http://127.0.0.1:8000/
  21 curl -H 'Accept: application/json; indent=4' -u admin:12345678

tutorial/quickstart/serializers.py

   1 from django.contrib.auth.models import User, Group
   2 from rest_framework import serializers
   3 
   4 class UserSerializer(serializers.HyperlinkedModelSerializer):
   5     class Meta:
   6         model = User
   7         # select fields to return
   8         fields = ['url', 'username', 'email', 'groups']
   9 
  10 class GroupSerializer(serializers.HyperlinkedModelSerializer):
  11     class Meta:
  12         model = Group
  13         # select fields to return
  14         fields = ['url', 'name']

tutorial/quickstart/views.py

   1 from django.contrib.auth.models import User, Group
   2 from rest_framework import viewsets
   3 from rest_framework import permissions
   4 from tutorial.quickstart.serializers import UserSerializer, GroupSerializer
   5 
   6 class UserViewSet(viewsets.ModelViewSet):
   7     """
   8     API endpoint that allows users to be viewed or edited.
   9     """
  10     queryset = User.objects.all().order_by('-date_joined')
  11     serializer_class = UserSerializer
  12     permission_classes = [permissions.IsAuthenticated]
  13 
  14 class GroupViewSet(viewsets.ModelViewSet):
  15     """
  16     API endpoint that allows groups to be viewed or edited.
  17     """
  18     queryset = Group.objects.all()
  19     serializer_class = GroupSerializer
  20     permission_classes = [permissions.IsAuthenticated]

tutorial/urls.py

   1 from django.urls import include, path
   2 from rest_framework import routers
   3 from tutorial.quickstart import views
   4 
   5 router = routers.DefaultRouter()
   6 router.register(r'users', views.UserViewSet)
   7 router.register(r'groups', views.GroupViewSet)
   8 
   9 # Wire up our API using automatic URL routing.
  10 # Additionally, we include login URLs for the browsable API.
  11 urlpatterns = [
  12     path('', include(router.urls)),
  13     path('api-auth/', include('rest_framework.urls', namespace='rest_framework'))
  14 ]