django restframework

django rest_framework(1)

创建项目

	mkdir tutorial
	cd tutoial
	virtialenv env
	source env/bin/activatie
	pip install django
	pip install djangorestframework
	django-admin startproject tutoial 
	cd tutorial
	django-admin startapp quickstart
	python manage.py migrate
	python manage.py createsuperuser --email admin@123.com --username admin

serializer

创建新模块 tutorial/quickstart/serializers.py 用于数据表示

	 from django.contrib.auth.models import user, Group
	 from rest_framework import serializers

	class UserSerializer(serializers.HyperlinkedModelSerializer):
		class Meta:
			model  = User
			fields = ('url', 'username', 'email', 'groups')


	class GroupSerializer(serializers.HyperlinkedModelSerializer):
	    class Meta:
	        model = Group
	        fields = ('url', 'name')

我们在这种情况下使用的是超链接关系HyperlinkedModelSerializer。您还可以使用主键和其他各种关系，但超链接是一种很好的RESTful设计。

View

from django.contrib.auth.models import User, Group
from rest_framework import viewsets
from tutorial.quickstart.serializers import UserSerializer, GroupSerializer


class UserViewSet(viewsets.ModelViewSet):
    """
    API endpoint that allows users to be viewed or edited.
    """
    queryset = User.objects.all().order_by('-date_joined')
    serializer_class = UserSerializer


class GroupViewSet(viewsets.ModelViewSet):
    """
    API endpoint that allows groups to be viewed or edited.
    """
    queryset = Group.objects.all()
    serializer_class = GroupSerializer

我们不是编写多个视图，而是将所有常见行为组合在一起调用ViewSets。

如果需要，我们可以轻松地将它们分解为单独的视图，但使用视图集可以使视图逻辑组织良好，并且非常简洁。

urls

tutorial/urls.py
from django.urls import include, path
from rest_framework import routers
from tutorial.quickstart import views

router = routers.DefaultRouter()
router.register(r'users', views.UserViewSet)
router.register(r'groups', views.GroupViewSet)

# Wire up our API using automatic URL routing.
# Additionally, we include login URLs for the browsable API.
urlpatterns = [
    path('', include(router.urls)),
    path('api-auth/', include('rest_framework.urls', namespace='rest_framework'))
]

因为我们使用视图集而不是视图，所以我们可以通过简单地使用路由器类注册视图集来自动为我们的API生成URL conf。

同样，如果我们需要更多地控制API URL，我们可以简单地使用常规的基于类的视图，并明确地编写URL conf。

最后，我们将包含默认登录和注销视图，以便与可浏览API一起使用。这是可选的，但如果您的API需要身份验证并且您想要使用可浏览的API，则非常有用。

pagination

分页允许您控制每页返回的对象数。要启用它，tutorial/settings.py

REST_FRAMEWORK = {
    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
    'PAGE_SIZE': 10
}

setting

添加’rest_framework’到INSTALLED_APPS。设置模块将在tutorial/settings.py

INSTALLED_APPS = (
    ...
    'rest_framework',
)

run

python manage.py runserver