​ 一：drf --drf入门规范

最新推荐文章于 2024-04-21 11:37:02 发布
最新推荐文章于 2024-04-21 11:37:02 发布
阅读量889 收藏 8
点赞数
分类专栏： # Django-rest-framework 文章标签： restful drf
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_38418803/article/details/109432693
版权

目录

一：web开发模式

1.1 前后端不分离

在这里插入图片描述

1.2 前后端分离

在这里插入图片描述

二：API接口

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

Web API接口和一般的url链接还是有区别的，Web API接口简单概括有下面四大特点

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

    https://api.map.baidu.com/place/v2/search

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

    采用get方式请求上方接口

  • 请求参数：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",
    "results":[
        {
            "name":"肯德基(罗餐厅)",
            "location":{
                "lat":31.415354,
                "lng":121.357339
            },
            "address":"月罗路2380号",
            "province":"上海市",
            "city":"上海市",
            "area":"宝山区",
            "street_id":"339ed41ae1d6dc320a5cb37c",
            "telephone":"(021)56761006",
            "detail":1,
            "uid":"339ed41ae1d6dc320a5cb37c"
        }
      	...
		]
}

三：接口测试工具：Postman

Postman是一款接口调试工具，是一款免费的可视化软件，同时支持各种操作系统平台，是测试接口的首选工具。

Postman可以直接从官网：https://www.getpostman.com/downloads/下载获得。

使用很简单，不多说。

四：RESTful API规范

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

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

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

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

restful十条规范

1 数据的安全保障

url链接一般都采用https协议进行传输

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

2 接口特征表现

用api关键字标识接口url：（两种方式）

	https://api.baidu.com
	https://www.baidu.com/api

注：看到api字眼，就代表该请求url链接是完成前后台数据交互的

3 多数据版本共存

在url链接中标识数据版本

	https://api.baidu.com/v1
	https://api.baidu.com/v2

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

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

  • 接口一般都是完成前后台数据的交互，交互的数据我们称之为资源

      https://api.baidu.com/users
  https://api.baidu.com/books   // 获取多本书
  https://api.baidu.com/book    // 获取一本书

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

  • 特殊的接口可以出现动词，因为这些接口一般没有一个明确的资源，或是动词就是接口的核心含义

      https://api.baidu.com/place/search
  https://api.baidu.com/login
5 （重点）资源操作由请求方式决定（method）

操作资源一般都会涉及到增删改查，我们提供请求方式来标识增删改查动作

	https://api.baidu.com/books - get请求：获取所有书
	https://api.baidu.com/books/1 - get请求：获取主键为1的书
	https://api.baidu.com/books - post请求：新增一本书书
	https://api.baidu.com/books/1 - put请求：整体修改主键为1的书
	https://api.baidu.com/books/1 - patch请求：局部修改主键为1的书
	https://api.baidu.com/books/1 - delete请求：删除主键为1的书
6 过滤，通过在url上传参的形式传递搜索条件
https://api.example.com/v1/zoos?limit=10：指定返回记录的数量
https://api.example.com/v1/zoos?offset=10：指定返回记录的开始位置
https://api.example.com/v1/zoos?page=2&per_page=100：指定第几页，以及每页的记录数
https://api.example.com/v1/zoos?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序
https://api.example.com/v1/zoos?animal_type_id=1：指定筛选条件
7 响应状态码
7.1 正常响应
响应状态码2xx
	200：常规请求
	201：创建成功
7.2 重定向响应
响应状态码3xx
	301：永久重定向
	302：暂时重定向
7.3 客户端异常
响应状态码4xx
	403：请求无权限
	404：请求路径不存在
	405：请求方法不存在
7.4 服务器异常
响应状态码5xx
	500：服务器异常
8 错误处理，应返回错误信息，error当做key
{
    error: "无权限操作"
}
9 返回结果，针对不同操作，服务器向用户返回的结果应该符合以下规范
	GET /collection：返回资源对象的列表（数组）
	GET /collection/resource：返回单个资源对象
	POST /collection：返回新生成的资源对象
	PUT /collection/resource：返回完整的资源对象
	PATCH /collection/resource：返回完整的资源对象
	DELETE /collection/resource：返回一个空文档
10 需要url请求的资源需要访问资源的请求链接

响应的数据里面可以带地址

# Hypermedia API，RESTful API最好做到Hypermedia，
# 即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么
{
  	"status": 0,
  	"msg": "ok",
  	"results":[
        {
            "name":"肯德基(罗餐厅)",
            "img": "https://image.baidu.com/kfc/001.png"
        }
      	...
		]
}

五：Django Rest_Framework

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

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

官方文档：https://www.django-rest-framework.org/

github: https://github.com/encode/django-rest-framework/tree/master

特点：

	- 提供了定义序列化器Serializer的方法，可以快速根据 Django ORM 或者其它库自动序列化/反序列化；
	- 提供了丰富的类视图、Mixin扩展类，简化视图的编写；
	- 丰富的定制层级：函数视图、类视图、视图集合到自动生成 API，满足各种需要；
	- 多种身份认证和权限认证方式的支持；[jwt]
	- 内置了限流系统；
	- 直观的 API web 界面；
	- 可扩展性，插件丰富

六：环境安装与配置

1 安装DRF

pip install djangorestframework

2 添加rest_framework应用

在settings.py的INSTALLED_APPS中添加’rest_framework’。

INSTALLED_APPS = [
    ...
    'rest_framework',
]

七：源码分析

APIView源码分析

源码中最重要就是as_view()和dispatch()

# 路由
	url(r'^books/api/view/', views.BooksAPIView.as_view()),
# 视图函数：
class BooksAPIView(APIView):
    def get(self, request):
        return HttpResponse('ok2')

def as_view(cls, **initkwargs):
	"""核心走了父类as_view()"""
	view = super(APIView, cls).as_view(**initkwargs)
	view.cls = cls
    view.initkwargs = initkwargs
   """返回的是局部禁用csrf认证的view视图函数"""
    return csrf_exempt(view)

"""
请求来了-->路由匹配上-->view(request)-->调用了self.dispatch()
	但是self是BooksAPIView,会先执行自己类中的dispatch()方法，
	没有则去执行APIView的dispatch()方法。
"""
# APIView中的disptch()方法：
def dispatch(self, request, *args, **kwargs):
    self.args = args
    self.kwargs = kwargs
    # 二次封装request对象				   ↓request是当次请求的request
    #再用request就是新的request对象
    request = self.initialize_request(request, *args, **kwargs)
    self.request = request
    self.headers = self.default_response_headers  
    
def initialize_request(self, request, *args, **kwargs)
	# 原生request封装在request._request
    
def initial(self, request, *args, **kwargs)
	# 认证
	self.perform_authentication(request)
    # 权限
    self.check_permissions(request)
    # 频率
    self.check_throttles(request)

request对象

只要继承了APIView，视图中的request对象都是新的request对象。
原来的request对象在request._request中

"""
以后使用request对象，就像使用之前request对象一样。（因为重写了__getattr__方法）
"""
    def __getattr__(self, attr):
        try:
        	# 通过反射，去原生request对象中取出属性或方
            return getattr(self._request, attr) 
        except AttributeError:
            return self.__getattribute__(attr)

"""
1. post请求参数从哪取？
	request.data:感觉是属性，实际是方法
	@property
	def data(self):
	    if not _hasattr(self, '_full_data'):
	        self._load_data_and_files()
	    return self._full_data
2. get请求参数从哪取？
	request.GET
	request.query_params:
		@property
	    def query_params(self):
	        return self._request.GET
"""

reqeust对象中方法和属性展示：
在这里插入图片描述

下一篇：二：drf-序列化组件

番茄炒鸡蛋z
关注
  • 0
    点赞
  • 踩
  • 8
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
DjangoRestFramework框架简介及基本使用
行者AI
01-28 828
本文首发于：行者AI 在python项目开发中，前后端分离的技术框架越来越成熟，在前后端进行通信时，通常需要用统一的格式进行通信，目前应用比较广泛的是RESTful API。那后端如何快速编写基于Django的RESTful API呢？本篇将主要介绍使用DjangoRestFramework（drf）框架来快速开发符合REST风格的API。 1. drf概念及特点 1.1 概念 drf框架是基于Django框架，用于快速构建Web RESTful API的工具。 1.2 特点 （1） 提供了定义序列化器.
drf-extensions:DRF-extensions是Django REST框架的自定义扩展的集合
04-06
Django REST框架扩展DRF-extensions是的自定义扩展的集合有关项目的完整文档，请参见赞助要求经过Python 3.6、3.7和3.8测试经过Django Rest Framework 3.9、3.10、3.11和3.12测试经过Django 2.2至3.1测试经过django-...
Django的web框架Django Rest_Framework精讲（四）
景天科技苑
02-04 1662
DRF除了提供序列化器，视图组件，路由组件外，还提供了很多其他组件，比如本章讲的认证组件，权限组件，限流组件，过滤组件，排序，分页，异常处理等组件。
inception网络_【TensorFlow实战笔记】 迁移学习实战卷积神经网络CNNInceptionv3模型...
weixin_39892447的博客
11-24 303
前言之前写的笔记拿过来，供大家参考IDE：pycharm Python: Python3.6 OS: win10代码已存档于github中https://github.com/chehongshu/DL-tenserflow/tree/master/The_migration_study_Inception-v3希望您 star一下，在此 感谢迁移学习1.所谓迁移学习，就是将一个问题...
【后端】Django与Django REST Framework的结合使用
最新发布
weixin_43366051的博客
04-21 1100
随着开发语言及人工智能工具的普及，使得越来越多的人会主动学习使用一些开发语言，本文主要介绍Django与Django REST Framework的结合使用。以上就是今天要讲的内容，本文简单介绍了Django项目的创建及与REST Framework的结合使用。在上面项目示例中也介绍了具体项目中是如何操作使用的，日常我们可以通过RESTful API来管理数据模型，并且可以通过访问相应的URL来访问和操作资源。
Python之Django-REST framework
wguo-up-site
11-29 2206
1. 环境安装 1.1 安装 pip install djangorestframework 1.2 添加rest_framework应用 在Django工程的settings.py的INSTALLED_APPS中添加’rest_framework’。 INSTALLED_APPS = [ ... 'rest_framework' ] 2. 序列化器 2.1 定义序列化器 Django REST framework中的Serializer使用类来定义，须继承自rest_framew
Instagram_test：DRF-示例
02-13
【标题】"Instagram_test：DRF-示例" 指的是一个基于Python的Django Rest Framework（DRF）创建的Instagram风格的应用程序示例。DRF是一个强大的、灵活的和可扩展的工具包，用于构建Web API。这个示例项目可能是为了...
django-react-app:drf-react-mobx
04-30
【标题】"django-react-app:drf-react-mobx"是一个项目，它结合了Django REST Framework（DRF）作为后端服务与React.js作为前端框架，利用MobX进行状态管理，构建了一个全栈Web应用。这个项目展示了如何将Python的...
drf-api-tracking：aschndrf-tracking的分支，以便我们可以维护和发布更新的版本
02-04
drf-api-tracking总览drf-api-tracking提供了Django模型和DRF视图混合，可将Django Rest Framework请求记录到数据库中。 对于每个使用mixin的视图，您将在每个请求/响应周期获得以下属性： 型号栏位名称描述模型字段...
drf-starter-template:具有drf-yasg，heroku部署就绪配置，CORS配置的DRF入门模板
05-01
drf-starter-template 一个使用Django Rest Framework的小型项目的易于使用的项目模板。 特征 准备在heroku上部署-包含用于将项目部署到heroku的所有软件包和配置。 您可以将该项目上传到heroku。 Swagger Schema ...
Django REST framework 简介与中文教程_restframework教程中文版(1)
2301_77033672的博客
04-13 1273
现在，我们已经在Web API上获得了一组相当细粒度的权限，以及系统用户和他们创建的代码片段的端点。在本教程的第5部分中，我们将研究如何通过为高亮显示的代码段创建HTML端点来将所有内容连接在一起，并通过使用超链接处理系统中的关系来提高API的内聚性。
DjangoRESTframework
qq_60976312的博客
11-16 2307
web应用模式 前后端分离 前后端不分离 前后端分离：后端仅返回前端所需的数据，不再渲染html页面，不再控制前端效果 前端展示的效果由前端自己决定 缺点：前后端耦合度相对较低 前后端不分离：前端页面看到的效果都是由后端控制，由后端渲染页面或者重定向 前后端耦...
Django框架
tainqiuer123的博客
04-23 1万+
一、如何解决组件不是内部或批处理命令 1、如果要使用pip,需要设置环境变量，添加比如D:\Python36\Scripts，因为pip在Scripts目录下 2、如何查找django全局目录pip show django 二、创建django框架 pip install django#安装django框架，Scripts目录新增文件 cd 工程目录#跳转工程目录 pip show django#获取框架目录，添加到全局变量 django-admin --version#查看是否安装
Django REST Framework教程(一分钟入门)
热门推荐
像蚂蚁一样工作，像蝴蝶一样生活
03-23 2万+
　　引言 　　使用Django Rest Framework之前我们要先知道，它是什么，能干什么用？ 　　引用官方一句话：Django REST框架是用于构建Web API的功能强大且灵活的工具包。 　　那为什么要使用Rest Framework？ 　　Django REST Framework可以在Django的基础上迅速实现API，并且自身还带有WEB的测试页面，可以方便的测试自己的...
Django REST framework 项目开发实战
11-16
课程介绍：          《Django REST framework项目开发实战》从构建一个Django REST framework开发项目到部署应用实践，由浅入深，引领学员逐步掌握各项技能，实战项目，且侧重技能不同，学员的知识体系会更加全面课程内容涵盖：                Django REST framework 介绍                Django REST framework API                分页                详情接口                加缓存为接口提速                API版本管理                限制接口访问频率学习基础：         Python基础                                      熟练Django： https://edu.csdn.net/course/detail/30834 
【Django】restframework框架介绍快速入门——参考官方文档
无邪的博客
03-27 557
我们将创建一个简单的 API，以允许管理员用户查看和编辑系统中的用户和组。官网原文：https://www.django-rest-framework.org/tutorial/quickstart/ 文章目录一、项目设置二、项目布局应如下所示：三、序列化程序四、视图五、网址六、分页七、设置八、测试我们的接口 一、项目设置 创建一个名为 的新 Django 项目，然后启动一个名为 的新应用程序。tutorial quickstart # Create the project directory mkd
使用Django完成接口API的开发（REST）
Seven597的博客
11-27 1930
使用Django实现REST urls.py 代码展示 from django.conf.urls import url from . import views urlpatterns = [ # 列表视图的路由 url(r'^books/$', views.BookListView.as_view()), # 详情视图的路由 url(r'^books/(?P<pk>\d+)/$',views.BookDetailView.as_view()), ] vie
Django REST framework框架
yangsen99的博客
07-31 2379
rest-framework框架主要帮助我们快速开发rest-framework接口，就算没有这个框架我们也可以实现这些功能吗，但是经过框架的封装，会更加简洁、方便。 1、APIView Django的rest-framework框架都是基于CBV来完成的，首先来了解一下CBV的执行流程 CBV执行流程 1、创建url 2、创建视图类 3、as_view方法源码 ...
Django Rest Framework - 初识
原小明
12-04 3643
Django的REST框架是一个强大而灵活的工具用于构建Web API。 1. 它是什么？Django REST framework is a powerful and flexible toolkit for building Web APIs. 翻译： 牛B的web API工具框架 作为一名Android 开发工程师 ，以我使用的rest api来说，这是我目前见过最方便的，最灵活的开发方式
drf-haystack
09-12
DRF-Haystack是一个用于将Django Rest Framework（DRF）与Haystack集成的库。Haystack是Django中的全文搜索框架，而DRF是一个用于构建RESTful API的强大框架。 DRF-Haystack提供了一组用于处理搜索请求和响应的DRF...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值