Django进阶:DRF(Django REST framework)

这篇具有很好参考价值的文章主要介绍了Django进阶:DRF(Django REST framework)。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

什么是DRF?

Django进阶:DRF(Django REST framework),python,django,python,后端,restful

DRFDjango REST framework的缩写,官网上说:Django REST framework是一个强大而灵活的工具包,用于构建Web API
简单来说:通过DRF创建API后,就可以通过HTTP请求来获取、创建、更新或删除数据(CRUD)。

那么为什么要构建API呢?
在Django中,我们通过model-view-template实现了后端和前端的通信。但前端未必是用Django的template实现的,也可以用单独的前端框架(如vue)实现。这个时候就需要一种统一的方法在前后端通信。目前一种成熟的方法就是API。

那么什么是REST?

如果你对DRF是用于构建Web API的说法已经满意了,就可以跳过这段了。
那么什么是REST?
REST(即 REpresentational State Transfer)是一种风格,用于在网络上的计算机系统之间提供标准,使系统更容易相互通信。特点是无状态和分离客户端和服务器。

也就是说,当你的API遵循了这种风格时,就可以称为RESTful API
关于如何设计出符合REST风格的API,可以参考阮一峰的《RESTful API 设计指南》

那么用DRF实现的就是RESTful API吗?其实DRF没有强制实现。
在官网的TOPIC,REST --> Hypermedia,Hateoas中有这样一段话:

首先,免责声明。“Django REST 框架”这个名字是在 2011 年初决定的,选择它只是为了确保开发人员很容易找到这个项目。在整个文档中,我们尝试使用更简单、技术上正确的术语“Web API”。

官网的一个例子

看一个官网的例子来感受一下。
创建一个简单的API,允许管理员查看和编辑系统中的用户和组。

详细的过程推荐看官网:https://www.django-rest-framework.org/tutorial/quickstart/

配置项目

首先安装drf:
pip install djangorestframework

然后创建一个Django项目并创建应用:

mkdir tutorial
cd tutorial

django-admin startproject tutorial .
cd tutorial
django-admin startapp quickstart

这里创建项目和应用的方式有点不同,按照他的这个就行。

settings.py中的INSTALLED_APPS添加rest_framework:

INSTALLED_APPS = [
    ...
    'rest_framework',
]

同步数据库
python manage.py migrate
创建超级用户admin,密码设置为password123:
python manage.py createsuperuser --email admin@example.com --username admin

创建API

接下来就是重点,我们要创建一个序列化程序将model转换成json格式。

1.创建序列化类
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']

序列化类(Serializer)将Model转换为序列化的JSON对象
上面构建了User和Group的序列化类。序列化类看起来和django的Form很像。

2.创建view
quickstart/views.py

from django.contrib.auth.models import User, Group
from rest_framework import viewsets
from rest_framework import permissions
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
    permission_classes = [permissions.IsAuthenticated]


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

我们使用了ModelViewSet来快速构建一组view。由于背后实现了很多方法,这看起来有些像魔法。

3.配置url
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'))
]

因为我们使用的是ViewSet而不是view,所以我们可以通过简单地将ViewSet注册到Router来自动生成API的 URL conf。

可以发现,和Django程序相比,我们没有写template做前端的显示,而是写了序列化类提供API。前端可以分离出来,使用API来和后端通信。

Django进阶:DRF(Django REST framework),python,django,python,后端,restful
Django进阶:DRF(Django REST framework),python,django,python,后端,restful
(图片来自:一图看懂Django和DRF(https://zhuanlan.zhihu.com/p/53957464))

测试API:

使用浏览器访问网址:
http://127.0.0.1:8000/users/

Django进阶:DRF(Django REST framework),python,django,python,后端,restful

由于设置了权限,没登陆时查看不了。点击login用管理员账号(admin,password123)登陆:
Django进阶:DRF(Django REST framework),python,django,python,后端,restful

可以看到JSON格式的数据。

也可以通过httpie工具(可以用pip安装)发送http请求获取数据:
http -a admin:password123 http://127.0.0.1:8000/users/

参考

DRF官网:https://www.django-rest-framework.org/
https://www.django-rest-framework.org/topics/rest-hypermedia-hateoas/
一图看懂Django和DRF:https://zhuanlan.zhihu.com/p/53957464
一文彻底弄懂REST API:https://zhuanlan.zhihu.com/p/536437382
RESTful API 设计指南:https://www.ruanyifeng.com/blog/2014/05/restful_api.html文章来源地址https://www.toymoban.com/news/detail-665940.html

到了这里,关于Django进阶:DRF(Django REST framework)的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • 深入探索 Django Rest Framework

    这篇文章会详细介绍Django REST Framework的核心组成部分,包括Serializers、ViewSets、Routers、权限和认证系统以及测试和调试工具。文章从基础开始,逐步深入,旨在帮助读者掌握使用Django REST Framework构建复杂API的技能。 Django REST框架,通常简称为DRF,是一个强大而灵活的Web API工具

    2024年02月15日
    浏览(28)
  • Django Rest_Framework(一)

    在开发Web应用中,有两种应用模式: 前后端不分离[客户端看到的内容和所有界面效果都是由服务端提供出来的。] 前后端分离【把前端的界面效果(html,css,js分离到另一个服务端或另一个目录下,python服务端只需要返回数据即可)】 前端形成一个独立的网站/独立的地址,服

    2024年02月14日
    浏览(30)
  • Django Rest_Framework(三)

    为了方便接下来的学习,我们创建一个新的子应用 opt 注册子应用 总路由,代码: 子路由,代码: 因为接下来的认证组件中需要使用到登陆功能,所以我们使用django内置admin站点并创建一个管理员. admin运营站点的访问地址:http://127.0.0.1:8000/admin 创建管理员以后,访问admin站

    2024年02月14日
    浏览(40)
  • django rest framework 学习笔记2

    注意:该文章部分摘抄之百度,仅当做学习笔记供小白使用,若侵权请联系删除! 显示关联表的数据,本示例会显示所有的关联的数据信息 读取到的结果器数据关联的为数字,此时需要进行一些操作可以读到正确数据 方法1: source=\\\'字段名.关联属性值\\\' 方法2 : 返回其属性值

    2024年02月20日
    浏览(29)
  • Django rest framework基本知识

    使用pycharm生成Django项目后,会生成工程目录和app目录 工程目录下5个文件,settings.py是全局配置相关的  urls.py是路有相关的 app相关的目录    models.py 数据库ORM对应的模型类  serializers.py 序列化与反序列化处理    views.py 根据request进行业务逻辑处理,返回response    admin.p

    2024年02月09日
    浏览(32)
  • Django Rest_Framework(二)

    什么时候声明的序列化器需要继承序列化器基类Serializer,什么时候继承模型序列化器类ModelSerializer? 看数据是否从mysql数据库中获取,如果是则使用ModelSerializer,不是则使用Serializer drf除了在数据序列化部分简写代码以外,还在视图中提供了简写操作。所以在django原有的dja

    2024年02月14日
    浏览(27)
  • 使用Django Rest framework搭建Blog

    在前面的Blog例子中我们使用的是GraphQL, 虽然GraphQL的使用处于上升趋势,但是Rest API还是使用的更广泛一些. 所以还是决定回到传统的rest api framework上来, Django rest framework的官网上给了一个很好用的QuickStart, 我参考Quick Start将前面的Blog的例子用DRF(Django Rest Framework)重新构筑一遍

    2023年04月19日
    浏览(31)
  • django rest framework 学习笔记-实战商城

     01项目环境搭建_哔哩哔哩_bilibili  本博客借鉴至大佬的视频学习笔记 创建apps文件夹放入的上面应用  创建shop数据库 mysql create database shop charset=utf8; Query OK, 1 row affected, 1 warning (0.01 sec)  公共表设计: 用户表结构设计  执行迁移文件,生成表结构 E:desktopmy_drfMyShoppython manag

    2024年02月22日
    浏览(33)
  • Django REST framework实现api接口

    drf 是Django REST framework的简称,drf 是基于django的一个api 接口实现框架,REST是接口设计的一种风格。 在django 上运行,首先要安装好django 和数据库驱动,后端接口就是对数据库资源的操作。 restful 接口的规范: 1、创建数据库表,在models.py中 要执行生成表的语句: 2、设置路由

    2024年02月11日
    浏览(33)
  • 【django2.0之Rest_Framework框架一】rest_framework序列器介绍

    Django RestFramework(简称DRF) 提供了序列化器Serialzier的定义,可以帮助我们简化序列化与反序列化的过程,不仅如此,还提供丰富的类视图、扩展类、视图集来简化视图的编写工作。REST framework还提供了认证、权限、限流、过滤、分页、接口文档等功能支持。 github地址: https://

    2024年02月07日
    浏览(34)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包