一：drf --drf入门规范

最新推荐文章于 2024-04-12 04:03:50 发布

番茄炒鸡蛋z

最新推荐文章于 2024-04-12 04:03:50 发布

阅读量885

点赞数

分类专栏： # Django-rest-framework 文章标签： restful drf

本文链接：https://blog.csdn.net/qq_38418803/article/details/109432693

版权

Django-rest-framework 专栏收录该内容

10 篇文章 3 订阅

订阅专栏

一：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
评论
一：drf --drf入门规范

目录一：web开发模式1.1 前后端不分离1.2 前后端分离二：API接口三：接口测试工具：Postman四：RESTful API规范restful十条规范1 数据的安全保障2 接口特征表现3 多数据版本共存4 （重点）数据即是资源，均使用名词（可复数）5 （重点）资源操作由请求方式决定（method）过滤，通过在url上传参的形式传递搜索条件7 响应状态码7.1 正常响应7.2 重定向响应7.3 客户端异常7.4 服务器异常8 错误处理，应返回错误信息，error当做key9 返回结果，针对不同操作，服
复制链接

扫一扫