Django REST framework初次使用

2021年09月15日 阅读数:5
这篇文章主要向大家介绍Django REST framework初次使用,主要内容包括基础应用、实用技巧、原理机制等方面,希望对大家有所帮助。

咱们将使用 django-rest 建立一个简单的API,以容许管理员用户查看和编辑系统中的user和group。javascript


建立一个项目css

建立一个名为tutorial的Django项目,而后启动一个名为quickstart的新应用程序,在你的电脑找到一个合适的位置执行这些命令。前端

mkdir tutorialcd tutorial
# Create a virtual environment to isolate our package dependencies locallypython3 -m venv envsource env/bin/activate # On Windows use `env\Scripts\activate`
# Install Django and Django REST framework into the virtual environmentpip install djangopip install djangorestframework
# Set up a new project with a single applicationdjango-admin startproject tutorial . # Note the trailing '.' charactercd tutorialdjango-admin startapp quickstartcd ..


项目目录结构是这样的
java

$ pwd<some path>/tutorial$ find .../manage.py./tutorial./tutorial/__init__.py./tutorial/quickstart./tutorial/quickstart/__init__.py./tutorial/quickstart/admin.py./tutorial/quickstart/apps.py./tutorial/quickstart/migrations./tutorial/quickstart/migrations/__init__.py./tutorial/quickstart/models.py./tutorial/quickstart/tests.py./tutorial/quickstart/views.py./tutorial/settings.py./tutorial/urls.py./tutorial/wsgi.py


应用程序是在项目目录中建立的,这可能看起来很不寻常。使用项目的名称空间能够避免与外部模块的名称冲突(这超出了快速入门的范围)。python

如今先同步你的数据库:shell

python manage.py migrate


咱们还将建立一个名为admin的初始用户,其密码为password123。稍后,咱们将在示例中验证该用户。数据库

python manage.py createsuperuser --email admin@example.com --username admin

一旦你创建了一个数据库,并建立了初始用户,准备开始,打开应用程序的目录。
django


Serializers后端

首先,咱们将定义一些序列化器。让咱们建立一个名为tutorial/quickstart/serializer .py的新模块,用于数据表示。serializers主要是验证前端传过来的数据是否正确,符合后端接口api接口的要求。开发中,不要相信前端传过来的任何数值,都要作字段的类型和是否合法校验。api

from django.contrib.auth.models import User, Groupfrom 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设计。


Views

好的,咱们最好写一些视图。打开tutorial/quickstart/views.py,开始输入。

from django.contrib.auth.models import User, Groupfrom rest_framework import viewsetsfrom 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

咱们不是编写多个视图,而是将全部常见的行为分组到称为viewset的类中。


若是须要的话,咱们能够很容易地将它们分解成单独的视图,可是使用viewset可使视图逻辑组织良好,而且很是简洁。


Urls

下面,咱们来链接API url。在tutorial/urls.py

from django.urls import include, pathfrom rest_framework import routersfrom 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'))]

由于咱们使用的是viewset而不是视图,因此咱们能够为咱们的API自动生成URL conf,只需将viewset注册到router类便可。

一样,若是咱们须要对API URL有更多的控制,咱们能够简单地使用常规的基于类的视图,并显式地编写URL conf。

最后,咱们在browsable API中包含了默认的login和logout视图。这是可选的,可是若是您的API须要身份验证,而且但愿使用browsable API,那么这是很是有用的。


Pagination

分页容许您控制每一个页面返回多少对象。要启用它,请将如下行添加到tutorial/settings.py中

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


Settings

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

INSTALLED_APPS = [
...
'rest_framework',]


到这里,咱们的接口代码部分就编写完成了,咱们能够测试写的接口是否符合前端要求了。

python manage.py runserver


使用浏览器访问 【http://127.0.0.1:8000/users/】 ,用户名和密码是你以前建立的  admin   password123 。

看到下面这个效果:


本文分享自微信公众号 - pythonista的平常(gh_fc70d5d98d3f)。
若有侵权,请联系 support@oschina.cn 删除。
本文参与“OSC源创计划”,欢迎正在阅读的你也加入,一块儿分享。