无脑教程,只为学习时不瞌睡,按照官网教程操作并抄一遍官网教程。
官网:http://www.django-rest-framework.org/tutorial/quickstart/
1、新建Django项目及app
django-admin.py startproject tutorial
django-admin.py startapp quickstart
# 初始化数据库表
python manage.py migrate
# 创建超级用户
python manage.py createsuperuser --email [email protected] --username admin
2、定义序列化器
首先,我们将定义一些序列化器。让我们创建一个名为的新模块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设计。
3、编写视图模块
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。
如果需要,我们可以轻松地将这些视图分解为单个视图,但使用视图集可以使视图逻辑组织良好,并且非常简洁。
4、链接URL
连接API URL。到tutorial/urls.py
from django.conf.urls import url, include
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 = [
url(r'^', include(router.urls)),
url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework'))
]
因为我们使用视图集而不是视图,所以我们可以通过简单地将视图集注册到路由器类来自动为我们的API生成URL conf。
同样,如果我们需要更多地控制API URL,我们可以简单地使用常规的基于类的视图,并明确地编写URL conf。
最后,我们将包含默认登录和注销视图,以便与可浏览API一起使用。这是可选的,但如果您的API需要身份验证并且您想要使用可浏览的API,则非常有用。
5、分页
分页允许您控制每页返回的对象数。要启用它,请添加以下行tutorial/settings.py
REST_FRAMEWORK = {
'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
'PAGE_SIZE': 10
}
6、添加rest_framework到app中
添加'rest_framework'到INSTALLED_APPS。设置模块将在tutorial/settings.py
INSTALLED_APPS = (
...
'rest_framework',
)