Django REST Framework教程(一分钟入门)

最新推荐文章于 2024-09-05 07:01:55 发布

全栈测试开发日记

最新推荐文章于 2024-09-05 07:01:55 发布

阅读量2.5w

点赞数 11

本文为博主原创文章，未经博主允许不得转载。欢迎加入测试开发交流QQ群：696400122，所有博主资源及干货尽在QQ群，另外博客园地址：https://www.cnblogs.com/liudinglong/。

本文链接：https://blog.csdn.net/liudinglong1989/article/details/105040492

版权

　　引言

　　使用Django Rest Framework之前我们要先知道，它是什么，能干什么用？

　　引用官方一句话：Django REST框架是用于构建Web API的功能强大且灵活的工具包。

　　那为什么要使用Rest Framework？

　　Django REST Framework可以在Django的基础上迅速实现API，并且自身还带有WEB的测试页面，可以方便的测试自己的API。

　　Web应用模式

　　我们开发django项目时，经常会接触的接口这个东西，那么django-web开发接口是怎样呢？先了解一下web前后端开发模式《django前后分离与不分离》，这篇文章是我发布在CSDN上的一篇简单叙述django开发模式。

总体上就是：

web应用模式分两种：

1. 前后端不分离

在前后端不分离的引用模式中，前端页面看到的效果都是由后端控制的，由后端页面渲染或者重定向，也就是后端需要控制前端的展示，前端与后端的耦合度很高，这种模式比较适合纯网页应用，但是后端对接APP时，App可能并不需要后端返回一个HTML网页,二仅仅是数据本身,所以后端原本返回网页的接口不在适用前端APP应用,为了对接APP后端嗨需再开发一套接口。

这个可以看我之前写的DJango博客就可以知道，每次返回时都是使用render 或者redirect来返回的，需要带上HTML页面和参数

2. 前后端分离

在前后端分离的应用模式中，后端仅返回前端所需要的数据，不再渲染HTML页面，不再控制前端的效果，只要前端用户看到什么效果，从后端请求的数据如何加载到前端中，都由前端自己决定，网页有网页自己的处理方式，APP有APP的处理方式，但无论哪种前端所需要的数据基本相同，后端仅需开发一套逻辑对外提供数据即可，在前后端分离的应用模式中,前端与后端的耦合度相对较低

在前后端分离的应用模式中,我们通常将后端开发的每一视图都成为一个接口,或者API,前端通过访问接口来对数据进行增删改查

如果项目的需求是后一种情况的话，那么就可以用到Django Rest Framework了。

感兴趣的可以参考官方资料：https://www.django-rest-framework.org/，如果看不懂英文的伙伴，可以参考rest的中文文档：http://www.iamnancy.top/djangorestframework/Home/

　　Django REST Framework项目

1.打开pycharm编辑器，新建项目，选择如下：

这里虚拟环境是django_rest，如果看不懂，可以参考我前面写的虚拟环境使用的文章。

2.建好之后的项目结构如下：

在创建的虚拟环境中安装Django REST framework：

　　开发步骤

　　上面已经安装好环境和包，现在就开始开发了。

1.首先配置setting文件，加入rest_framework应用。

2.全局设置，分页和API使用权限问题，指定管理员使用：

# 设置权限策略：
REST_FRAMEWORK = {
    'DEFAULT_PERMISSION_CLASSES': [
        'rest_framework.permissions.IsAdminUser',
    ],
    'PAGE_SIZE': 10
}

3.数据迁移

4.创建管理员账号：

5. 创建数据序列化，主要来展示数据：

在api应用下面新建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')

说明：serializers用户定义API表现形式，比如返回哪些字段，什么格式等，这里是序列化django自带的User和Group。

6.创建视图函数：

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路径。
    """
    queryset = User.objects.all().order_by('-date_joined')
    serializer_class = UserSerializer


class GroupViewSet(viewsets.ModelViewSet):
    """
    允许组查看或编辑的API路径。
    """
    queryset = Group.objects.all()
    serializer_class = GroupSerializer

7.在django_restAPI目录下url.py中，添加api的路由配置：

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)

# 使用自动URL路由连接我们的API。
# 另外，我们还包括支持浏览器浏览API的登录URL。
urlpatterns = [
    url(r'^', include(router.urls)),
    url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework'))
]

8.到此所有东西都已经写完，然后我们运行runserver命令：