drf入门

于 2024-08-18 18:33:43 发布
阅读量475 收藏 13
点赞数 17
文章标签： django
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/g1446992400/article/details/141303472
版权

【一】前后端开发模式

【1】前后端混合开发

  • 目前还有不少公司在使用flask 混合 和Django 混合

  • 例如之前做的bbs项目

    • 模板：dtl语法：django template language 模板语法

      • {{ }}

      • {% %}

    • 在后端渲染： qs对象 --- 循环写到模版中 ---模版语法写的

    • 渲染完后---模版---纯粹的html，css，js 不会再含有模版语法

    • 返回到客户端浏览器 --- 看到好看的样式

  • 如果要做混合开发

    • 需要会后端，还需要稍微会一点前端 前端后端配合进行全栈开发

【2】前后端分离开发

  • 后端只做后端内容 --- 前端只做前端内容

  • 后端只需要写API接口

  • 前端专门做前端的内容

  • 最后进行前后端连调

【二】api接口

【1】什么是api接口

  • 为了在团队内部形成共识、防止个人习惯差异引起的混乱，我们需要找到一种大家都觉得很好的接口实现规范，而且这种规范能够让后端写的接口，用途一目了然，减少双方之间的合作成本。

  • 通过网络，规定了前后台信息交互规则的url链接，也就是前后台信息交互的媒介

127.0.0.1:8080/login/?name=knight&age=19
127.0.0.1:8080/books/

【2】api接口的特点

  • url：长得像返回数据的url链接

  • 请求方式：get、post、put、patch、delete

    • 采用get方式请求上方接口

  • 请求参数：地址栏中参数 和 请求体中参数：urlencoded,form-data,json(用的多)

  • json或xml格式的key-value类型数据

    • ak：6E823f587c95f0148c19993539b99295

    • region：上海

    • query：肯德基

    • output：json

  • 响应结果：json或xml格式的数据

    • 上面的output参数值决定了响应数据的格式

    # xml格式
https://api.map.baidu.com/place/v2/search?ak=6E823f587c95f0148c19993539b99295&region=%E4%B8%8A%E6%B5%B7&query=%E8%82%AF%E5%BE%B7%E5%9F%BA&output=xml
# json格式
https://api.map.baidu.com/place/v2/search?ak=6E823f587c95f0148c19993539b99295&region=%E4%B8%8A%E6%B5%B7&query=%E8%82%AF%E5%BE%B7%E5%9F%BA&output=json
    
{
    "status":0,
    "message":"ok",
    "result_type":"poi_type",
    "results":[
        {
            "name":"肯德基(美兰店)",
            "location":{
                "lat":31.40884,
                "lng":121.357373
            },
            "address":"罗芬路1088号",
            "province":"上海市",
            "city":"上海市",
            "area":"宝山区",
            "street_id":"",
            "telephone":"(021)33703920",
            "detail":1,
            "uid":"efa262ccec2ce3be9b68b4a8"
        },
        {
            "name":"肯德基(丁香店)",
            "location":{
                "lat":31.225372,
                "lng":121.549768
            },
            "address":"世纪大道2002号",
            "province":"上海市",
            "city":"上海市",
            "area":"浦东新区",
            "street_id":"",
            "telephone":"(021)68544927",
            "detail":1,
            "uid":"00586108ae5beabc47e274ad"
        },
    ]
}

【三】接口测试工具

【四】restful规范（面试可能会问）

  • REST全称是Representational State Transfer，中文意思是表述（编者注：通常译为表征性状态转移）。 它首次出现在2000年Roy Fielding的博士论文中。

  • RESTful是一种定义Web API接口的设计风格，尤其适用于前后端分离的应用模式中。

  • 这种风格的理念认为后端开发任务就是提供数据的，对外提供的是数据资源的访问接口，所以在定义接口时，客户端访问的URL路径就表示这种要操作的数据资源。

  • 事实上，我们可以使用任何一个框架都可以实现符合restful规范的API接口

【1】数据的安全保障

  • url链接一般都采用https协议进行传输，比http协议安全

  • 注：采用https协议，可以提高数据交互过程中的安全性

【2】接口特征表现

【3】多数据版本共存

注：url链接中的v1、v2就是不同数据版本的体现（只有在一种数据资源有多版本情况下）

【4】数据即是资源，均使用名词（可复数）

注：一般提倡用资源的复数形式，在url链接中不要出现操作资源的动词，错误示范：https://api.baidu.com/delete-user

【5】资源操作由请求方式决定（method）

【6】过滤，通过在url上传参的形式传递搜索条件

【7】响应状态码

  • 正常响应（响应状态码2xx）

    • 200：常规请求

    • 201：创建成功

  • 重定向响应（响应状态码3xx）

    • 301：永久重定向

    • 302：暂时重定向

  • 客户端异常（响应状态码4xx）

    • 403：请求无权限

    • 404：请求路径不存在

    • 405：请求方法不存在

  • 服务器异常（响应状态码5xx）

    • 500：服务器异常

【8】错误处理

  • 错误处理：应返回错误信息，error当做key

{
    error: "无权限操作"
}

【9】返回结果

  • 返回结果：针对不同操作，服务器向用户返回一个结果应该符合一些规范

GET /collection：返回资源对象的列表（数组）
GET /collection/resource：返回单个资源对象
POST /collection：返回新生成的资源对象
PUT /collection/resource：返回完整的资源对象
DELETE /collection/resource：返回一个空文档

【10】请求链接

  • 当需要url请求的资源时，需要访问资源的请求链接

# 响应数据要有状态码、状态信息以及数据本身
{
    "status": 0,
    "msg": "ok",
    "results":[
        {
            "name":"肯德基(罗餐厅)",
            "location":{
                "lat":31.415354,
                "lng":121.357339
            },
            "address":"月罗路2380号",
            "province":"上海市",
            "city":"上海市",
            "area":"宝山区",
            "street_id":"339ed41ae1d6dc320a5cb37c",
            "telephone":"(021)56761006",
            "detail":1,
            "uid":"339ed41ae1d6dc320a5cb37c"
        }
        ...
        ]
}

【五】序列化

api接口开发，最核心最常见的一个过程就是序列化，所谓序列化就是把数据转换格式，序列化可以分两个阶段：

序列化： 把我们识别的数据转换成指定的格式提供给别人

例如：我们在django中获取到的数据默认是模型对象，但是模型对象数据无法直接提供给前端或别的平台使用，所以我们需要把数据进行序列化，变成字符串或者json数据，提供给别人

反序列化：把别人提供的 数据转换/还原成 我们需要的格式。

例如：前端js提供过来的json数据，对于python而言就是字符串，我们需要进行反序列化换成模型类对象，这样我们才能把数据保存到数据库中

【六】Django Rest_Framework

drf是什么：django rest framwork，django框架上 一个可以快速实现restful规范接口的 快速开发框架

核心思想：缩减编写api接口的代码

Django REST framework是一个建立在Django基础之上的Web 应用开发框架，可以快速的开发REST API接口应用。在REST framework中，提供了序列化器Serialzer的定义，可以帮助我们简化序列化与反序列化的过程，不仅如此，还提供丰富的类视图、扩展类、视图集来简化视图的编写工作。REST framework还提供了认证、权限、限流、过滤、分页、接口文档等功能支持。REST framework提供了一个API 的Web可视化界面来方便查看测试接口。

官方文档：Home - Django REST framework

github: GitHub - encode/django-rest-framework: Web APIs for Django. 🎸

特点

  • 提供了定义序列化器Serializer的方法，可以快速根据Django ORM或者其他库自动 序列化/反序列化

  • 提供了丰富的类视图、Mixin扩展类，简化视图的编写

  • 丰富的定制层级：函数视图、类视图、视图集合到自动生成API，满足各种需求

  • 多种身份认证和权限认证方式的支持

  • 内置了限流系统

  • 直观的API web界面

  • 可扩展性，插件丰富

【七】drf安装

当前Django版本来到了5版本，但是开发追求稳定，使用Django4版本
最新drf支持django4.x以上
django：pip3 install django==4.2.14
drf：pip3 install djangorestframework --upgrade     # 3.15.2
这里的 --UPgrade 是指安装最新版本的drf

【八】drf使用小案例

在项目中如果使用rest_framework框架实现API接口，主要有以下三个步骤:

将请求的数据（如json格式）转换为模型类对象
操作数据库
将模型类对象转换为响应的数据（如JSON格式）

  • 创建Django项目

  • 创建app

  • 添加rest_framework应用：在settings.py的INSTALLED_APPS中添加’rest_framework’。

INSTALLED_APPS = [
    ...
    'rest_framework',
]

  • 创建模型表 models.py

from django.db import models


# Create your models here.

class Book(models.Model):
    name = models.CharField(max_length=64)
    price = models.IntegerField()

  • 连接数据库setting.py

DATABASES = {
    # 'default': {
    #     'ENGINE': 'django.db.backends.sqlite3',
    #     'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
    # },
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': "students",
        "HOST": "127.0.0.1",
        "PORT": 3306,
        "USER": "root",
        "PASSWORD":"123",
    },
}

  • 迁移数据库 makemigrations migrations

  • 配置路由

  • urls.py

from django.contrib import admin
from django.urls import path, include

urlpatterns = [
    path('admin/', admin.site.urls),
    path("api/v1/", include("app01.urls"))
]

  • app01\urls.py

from .views import BookView
from rest_framework.routers import SimpleRouter

router = SimpleRouter()
router.register("books", BookView, "books")	# 向路由器中注册视图集

urlpatterns = [
]

urlpatterns += router.urls

  • 视图类 app01\views.py

from .models import Book
from rest_framework.viewsets import ModelViewSet
from .serializer import BookSerializer


class BookView(ModelViewSet):
    serializer_class = BookSerializer
    queryset = Book.objects.all()
    # queryset 指明该视图集在查询数据时使用的查询集
    # serializer_class 指明该视图在进行序列化和反序列化时 使用的序列化器

  • 新建文件app01\serializer.py

from rest_framework import serializers
from .models import Book


class BookSerializer(serializers.ModelSerializer):
    class Meta:
        model = Book
        fields = "__all__"
        # model 指明该序列化器处理的数据字段从模型类Book参考生成
        # fields 指明该序列化器包含模型类中的哪些字段，’all‘指明包含所有字段

  • 查看所有

  • 添加

  • 查看单个

  • 修改

    • 返回修改之后的结果

  • 删除

    • 返回空

【九】drf学习内容

  1. 请求和响应

    • request：请求对象：请求方式，请求携带的数据

    • request.GET,request.POST,requset.body,request.META:请求头中得

    • 四件套

      • HTTPResponse('sdfs')

      • JsonResponse(字典列表)

      • render(request,模版文件)

    • drf也有自己的请求和响应

      • request

      • Response 的对象

  2. 序列化类：Serializer

    • 做序列化

    • 做反序列化

    • 反序列化的校验

  3. 视图类：drf提供了非常多 视图类可以继承

  4. 路由

  5. 认证：登录认证

  6. 权限

  7. 频率限制

  8. 统一返回错误

  9. jwt：登录认证用

  10. 基于角色的访问控制

【补充】

# get请求能不能再请求体中携带数据？
	能，但一般都是post或者put请求在请求体中携带数据
# 总结：
	Django视图类或者视图函数的request
    	request.POST：只针对于post请求的urlencoded编码格式  才会有数据
        
        request.GET:请求地址栏中的参数 get post delete put
            <QueryDict: {'key': ['key', '99']}>
           	上面这个是类字典：取出key的值方式
            	只取一个:request.GET.get('key')
                两个都取:request.GET.getlist('key')
                    
        request.body:无论什么请求，无论什么编码格式，都在里面
    http不同编码格式
    
    	urlencoded：在请求体中是  key=value&key=value
        
        json:在请求体中是  {"name":"knight","age":19}
            
        form-data: asdfasdf-------数据部分  asdfasdfasdf-----文件部分
唯有聪明绝顶
关注
  • 17
    点赞
  • 踩
  • 13
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
DRF框架讲解(深入DRF机制和原理)
11-22
这是一份最真的教程:深入DRF机制和原理,对关系字段的序列化和编写视图的方式进行重点讲解,不泛泛而谈。 这是一份深入源码的教程:深入剖析大量源码,逐行讲解,
Drf简介，什么是drf
weixin_46407419的博客
04-22 1537
Drf简介 在了解Drf之前先了解几个知识点 web开发模式 混合开发 # 前后端混合开发： - 模板的渲染是在后端完成： 比如： 后端： name = 'gary' 前端： var name = {{ name }} # 这个name是后端渲染过来的 # 那么就相当于在前端定义：var name = 'g...
什么是DRF？
qq_47214490的博客
09-22 6086
DRF(django rest framework)是基于django的一个框架，可以帮助我们快速开发restful规范的的接口框架 什么是restful REST与技术⽆关，代表的是⼀种软件架构⻛格（REST是Representational state transfer的简称，中⽂翻译为 表征状态转移） REST从资源的⻆度类审视整个⽹络，它将分布在⽹络中某个节点的资源通过URL进⾏标识 所有的数据，不过是通过⽹络获取的还是操作（增删改查）的数据，都是资源，将⼀切数据视为资源是REST区别与其他
DRF是什么
qq_59362150的博客
08-08 941
如果你正在使用Django（一个用Python编写的高级Web框架）并希望创建一个RESTful的Web服务，那么DRF是一个极好的选择。总的来说，Django REST framework是一个全面的工具集，可以帮助你快速地构建并维护你的Web API。：DRF包括一套全面的身份验证和权限策略，可以帮助你保护你的API，并确保只有合适的用户能够访问特定的资源。：DRF提供了一个浏览器友好的API界面，你可以在浏览器中直接查看和交互你的API。：DRF包括一个可选的客户端库，用于与DRF后端交互。
DRF从入门到精通一（DRF介绍、API接口、接口测试工具、Restful规范、序列化反序列化、基于drf、原生编写接口，APIView源码分析）
最新发布
Mchen的博客
12-15 1932
大体流程就是：前端在编写完静态页面之后，需要发送给后端人员做二次处理，所有的html代码和数据在服务器拼接好，等前后端处理好模版之后在做整合，然后一次性将所有内容发送到客户端，浏览器执行代码，将内容呈现给客户。，后端人员向前端开放数据接口(路由)，视图层不在直接返回给浏览器了，而是与前端做起了数据交互，实际上返回界面的还是前端，前端工作人员调用接口获取数据，从而将数据显示到页面。主要功能是发送http请求。Apifox也是一款接口调试工具，也是免费的可视化软件，相较而言我觉得是比Postman更好用一下。
drf-starter-template:具有drf-yasg，heroku部署就绪配置，CORS配置的DRF入门模板
05-01
drf-starter-template 一个使用Django Rest Framework的小型项目的易于使用的项目模板。 特征 准备在heroku上部署-包含用于将项目部署到heroku的所有软件包和配置。 您可以将该项目上传到heroku。 Swagger Schema ...
DjangoDRF框架阶段讲义
06-27
2. **DRF入门**：学习序列化、视图、路由等基本概念，搭建一个简单的API。 3. **高级特性**：深入理解权限认证、过滤、分页、异常处理等高级特性。 4. **实践项目**：通过实战项目巩固知识，如构建一个博客API或用户...
DjangoRestFrameWork从入门到精通源码分析.docx
03-08
DjangoRestFrameWork从入门到精通源码分析 DjangoRestFrameWork是一个基于Django框架的RESTful API框架，它提供了一整套的工具和组件来帮助开发者快速构建RESTful API。下面是对DjangoRestFrameWork的详细知识点...
django rest framework入门.zip
04-03
这个入门教程将引导你了解如何利用DRF来创建高效且易于理解的APIs。 **一、安装DRF** 在开始之前，确保已经安装了Python和Django。使用pip安装DRF： ``` pip install djangorestframework ``` **二、设置项目和...
Django入门与实践教程1
08-03
【Django入门与实践教程1】是一份针对初学者的详尽教程，旨在引导读者从零开始构建一个实际的Django项目。教程涵盖了从环境搭建到项目部署的全过程，涉及了Django框架的核心概念和技术。 首先，【环境搭建】章节会...
Django 基础之（九）drf介绍.md
weixin_34194087的博客
11-28 118
DRF 为什么要进行前后端分离 PC,APP,PAD多端适配 SPA开发模式的流行 前后端职责不清 前后端开发效率问题，前后端相互等待 前段一直配合后端，能力受到限制 后端开发语言和模板高度耦合，导致开发语言依赖严重 前后端分离的缺点 前后端学习门槛增加 数据依赖，导致文档的重要性增加 前段工作量加大 SEO难度增大 后端开发迁移成...
drf 框架
技术研究中心
10-15 6869
一. drf简介 　　drf框架,全程: django-rest framework , rest是插件名字,django插件的名字叫rest,framework是框架的意思 二. 接口 　　在平时生活中,接口是联系两个物质的媒介, 完成信息的交互. 在web程序中是联系前台页面与后台 数据库的媒介 　　web接口组成: url: 长得像返回数据(api.baidu.map/searc...
drf
ailinyingai的博客
09-03 1383
APIView APIView是drf概念体系中最基本类视图，它基于Django的View，同时又实现了一层对自己创造的概念的封装，比如permission_classes，render_classes，authentication_classes等，相当于请求过来后又进入一层，过滤（验证、初始化）完要走的这些classes，才能执行到我们自己实现的view。 Mixin 在介绍Generic v...
DRF
weixin_30278311的博客
07-09 588
1. Web应用模式 在开发Web应用中，有两种应用模式： 前后端不分离 前后端分离 2. api接口 为了在团队内部形成共识、防止个人习惯差异引起的混乱，我们需要找到一种大家都觉得很好的接口实现规范，而且这种规范能够让后端写的接口，用途一目了然，减少双方之间的合作成本。 目前市面上大部分公司开发人员使用的接口服务架构主要有：restful、rpc。 rpc: 翻译成中文:远程过程调用...
【django】DRF
rikka
04-23 385
DRF DRF（Django REST framework）框架是建立在Django框架基础之上，本质上它就是Django的一个App，通过DRF能够快速设计符合RESTful规范的接口，并且它还提供了一些功能。 安装 pip3 install djangorestframework 使用 drf本质是一个app，所以如果想要在Django项目中使用它就需要在settings配置文件中进行注册 ...
DRF快速入门：项目设置与序列化
本教程将引导我们快速入门，了解如何配置和使用DRF。 1. 项目设置 在项目设置部分，首先通过`python manage.py startapp quickstart`命令创建了一个名为"quickstart"的应用。然后执行`migrate`命令来应用数据库...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值