一、Restful规范

Restful规范是一种web API接口的设计风格,在前后端分离的应用模式中适用较多。

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

十条规范

1、是数据的安全保障:url链接一般都采用HTTPS协议进行传输

2、接口特征表现,一看就知道是个api接口

用api关键字标识接口url:

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

3、多数据版本共存

在url链接中标识数据版本:url链接中的v1、v2就是不同数据版本的体现(只有在一种数据资源有多版本情况下)

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

4、数据即是资源,均使用名词(可复数) **

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

  1. https://api.baidu.com/users
  2. https://api.baidu.com/books
  3. https://api.baidu.com/book

**5、资源操作由请求方式决定(method) ** **

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

  1. https://api.baidu.com/books - get请求:获取所有书
  2. https://api.baidu.com/books/1 - get请求:获取主键为1的书
  3. https://api.baidu.com/books - post请求:新增一本书书
  4. https://api.baidu.com/books/1 - put请求:整体修改主键为1的书
  5. https://api.baidu.com/books/1 - delete请求:删除主键为1的书

6、过滤,通过在url上传参的形式传递搜索条件

  1. https://api.example.com/v1/zoos?limit=10: 指定返回记录的数量
  2. https://api.example.com/v1/zoos?offset=10: 指定返回记录的开始位置
  3. https://api.example.com/v1/zoos?page=2&per_page=100:指定第几页,以及每页的记录数
  4. https://api.example.com/v1/zoos?sortby=name&order=asc:指定返回结果按照哪个属性排序,以及排序顺序
  5. https://api.example.com/v1/zoos?animal_type_id=1: 指定筛选条件

7、响应状态码

  1. 正常响应
  2. 响应状态码2xx
  3. 200:常规请求
  4. 201:创建成功
  5. 重定向响应
  6. 响应状态码3xx
  7. 301:永久重定向
  8. 302:暂时重定向
  9. 客户端异常
  10. 响应状态码4xx
  11. 403:请求无权限
  12. 404:请求路径不存在
  13. 405:请求方法不存在
  14. 服务器异常
  15. 响应状态码5xx
  16. 500:服务器异常

8、错误处理、应返回错误信息,error当做key

  1. {
  2. "error": "无权限操作"
  3. }

9、返回结果,针对不同操作,服务器向返回的结果应该符合以下规范

  1. GET /collection 返回资源对象的列表(数组)
  2. GET /collection/resource 返回单个资源对象
  3. POST /collection 返回新生成的资源对象
  4. PUT /collection/resource 返回完整的资源对象
  5. PATCH /collection/resource 返回完整的资源对象
  6. DELETE /collection/resource:返回一个空文档

10、需要url请求的资源需要访问资源的请求链接

  1. {
  2. "status": 0,
  3. "msg": "ok",
  4. "results":[
  5. {
  6. "name":"肯德基(罗餐厅)",
  7. "img": "https://image.baidu.com/kfc/001.png"
  8. }
  9. ]
  10. }

二、drf的简单使用

1、在setting.py 的app中注册

  1. INSTALLED_APPS = [
  2. 'rest_framework'
  3. ]

2、在models.py中写表模型

  1. class Book(models.Model):
  2. nid=models.AutoField(primary_key=True)
  3. name=models.CharField(max_length=32)
  4. price=models.DecimalField(max_digits=5,decimal_places=2)
  5. author=models.CharField(max_length=32)

3、新建一个序列化类

  1. from rest_framework.serializers import ModelSerializer
  2. from app01.models import Book
  3. class BookModelSerializer(ModelSerializer):
  4. class Meta:
  5. model = Book
  6. fields = "__all__"

4、在视图中写视图类

  1. from rest_framework.viewsets import ModelViewSet
  2. from .models import Book
  3. from .ser import BookModelSerializer
  4. class BooksViewSet(ModelViewSet):
  5. queryset = Book.objects.all()
  6. serializer_class = BookModelSerializer

5、写路由关系

  1. from app01 import views
  2. from rest_framework.routers import DefaultRouter
  3. router = DefaultRouter() # 可以处理视图的路由器
  4. router.register('book', views.BooksViewSet) # 向路由器中注册视图集
  5. # 将路由器中的所以路由信息追到到django的路由列表中
  6. urlpatterns = [
  7. path('admin/', admin.site.urls),
  8. ]
  9. # 两个列表相加
  10. urlpatterns += router.urls

三、APIView源码分析

ModelViewSet继承View(django原生View)

APIView继承了View

先读View的源码

CBV源码分析

  1. from django.views import View
  2. # urls.py
  3. # views.Books.as_view()是一个函数内存地址,as_view是一个类方法,Books类直接调用,会把类自动传入
  4. path('books/', views.Books.as_view()),
  5. # as_view返回了一个内层函数view,相当于放了一个view的内存地址(View——>as_view——>内层函数)
  6. # 请求来了,如果路径匹配,会执行————> view(request)
  7. def view(request, *args, **kwargs):
  8. self = cls(**initkwargs)
  9. self.setup(request, *args, **kwargs)
  10. if not hasattr(self, 'request'):
  11. raise AttributeError(
  12. "%s instance has no 'request' attribute. Did you override "
  13. "setup() and forget to call super()?" % cls.__name__
  14. )
  15. return self.dispatch(request, *args, **kwargs)
  16. # 然后返回一个self.dispatch方法,self是谁调用就是谁,由于是Books.as_view(),所以self是Books对象,而Books类继承了View类,所以执行在View类中的dispatch方法
  17. def dispatch(self, request, *args, **kwargs):
  18. if request.method.lower() in self.http_method_names: # 先判断请求方式是否存在
  19. # 存在则反射self(Books)中的请求方法的内存地址————>handler=getattr(self,'get')
  20. handler = getattr(self, request.method.lower(), self.http_method_not_allowed)
  21. else:
  22. handler = self.http_method_not_allowed
  23. return handler(request, *args, **kwargs) # 执行get(request)

APIView源码分析

  1. from rest_framework.views import APIView
  2. # urls.py
  3. # 这里同样写的是个函数的内存地址,不过是用的APIView里的as_view方法
  4. path('booksapiview/', views.BooksAPIView.as_view()),
  5. # APIView的as_view方法(类的绑定方法)
  6. @classmethod
  7. def as_view(cls, **initkwargs):
  8. ......
  9. # 主要的如下
  10. # 先调用了父类(View)的as_view方法
  11. view = super().as_view(**initkwargs)
  12. # 当调用了父类(View)的as_view方法会执行self.dispatch(),此时的self是BooksAPIView,并且继承了APIView类,所以此时的dispatch()方法是APIView的dispatch()方法(原dispatch方法被重写了)
  13. view.cls = cls
  14. view.initkwargs = initkwargs
  15. # 以后的所有请求都没有csrf认证了,只要继承了APIView,就没有CSRF认证
  16. return csrf_exempt(view)
  17. # 局部禁用csrf,在视图上加装饰器@csrf_exempt,和csrf_exempt(view)是一样的
  18. # 请求来了——》路由匹配上——》view(request)——》调用了self.dispatch()——》执行APIView的dispatch方法
  19. # APIView的dispatch方法
  20. def dispatch(self, request, *args, **kwargs):
  21. self.args = args
  22. self.kwargs = kwargs
  23. # 将原生的request包装成一个新的request,以后在用request,就是新的request对象了
  24. request = self.initialize_request(request, *args, **kwargs)
  25. self.request = request
  26. self.headers = self.default_response_headers # deprecate?
  27. try:
  28. # 三大认证模块
  29. self.initial(request, *args, **kwargs)
  30. # 这里就相当于原生的dispatch方法的反射,先判断请求方法是否存在,在去反射获取请求方法的内存地址
  31. if request.method.lower() in self.http_method_names:
  32. handler = getattr(self, request.method.lower(),
  33. self.http_method_not_allowed)
  34. else:
  35. handler = self.http_method_not_allowed
  36. # 响应模块
  37. response = handler(request, *args, **kwargs)
  38. except Exception as exc:
  39. # 异常模块
  40. response = self.handle_exception(exc)
  41. # 渲染模块,
  42. self.response = self.finalize_response(request, response, *args, **kwargs)
  43. return self.response
  44. # APIView的initial方法(三大认证模块)
  45. def initial(self, request, *args, **kwargs):
  46. ...
  47. # 认证组件:校验用户 - 游客、合法用户、非法用户
  48. # 游客:代表校验通过,直接进入下一步校验(权限校验)
  49. # 合法用户:代表校验通过,将用户存储在request.user中,再进入下一步校验(权限校验)
  50. # 非法用户:代表校验失败,抛出异常,返回403权限异常结果
  51. self.perform_authentication(request)
  52. # 权限组件:校验用户权限 - 必须登录、所有用户、登录读写游客只读、自定义用户角色
  53. # 认证通过:可以进入下一步校验(频率认证)
  54. # 认证失败:抛出异常,返回403权限异常结果
  55. self.check_permissions(request)
  56. # 频率组件:限制视图接口被访问的频率次数 - 限制的条件(IP、id、唯一键)、频率周期时间(s、m、h)、频率的次数(3/s)
  57. # 没有达到限次:正常访问接口
  58. # 达到限次:限制时间内不能访问,限制时间达到后,可以重新访问
  59. self.check_throttles(request)

只要继承了APIView,视图类中的request对象都是新的,也就是上面那个request对象,

原生的request在新的request._request中

以后使用request对象,就像使用之前的request是一样的(因为重写了__getattr__方法)

  1. from rest_framework.request import Request
  2. # 点拦截,当新request.的时候触发
  3. def __getattr__(self, attr):
  4. try:
  5. return getattr(self._request, attr) # 通过反射,获取原生request对象,取出属性或方法
  6. except AttributeError:
  7. return self.__getattribute__(attr)
  8. # request.data 是一个方法,不过是被@property装饰了
  9. # request.data 是一个字典,post请求不管使用什么编码,传过来的数据都在request.data中
  10. # get请求的数据还可以在request.query_params中取
  11. @property
  12. def query_params(self):
  13. return self._request.GET
  14. # 视图类中
  15. print(request.query_params) # get请求,地址中的参数
  16. # 原来在
  17. print(request.GET)

Restful规范-APIView源码分析的更多相关文章

  1. CBV源码分析+APIVIew源码分析

    {drf,resful,apiview,序列化组件,视图组件,认证组件,权限组件,频率组件,解析器,分页器,响应器,URL控制器,版本控制} 一.CBV源码分析准备工作: 新建一个Django项目 写 ...

  2. $Django cbv源码分析 djangorestframework框架之APIView源码分析

    1 CBV的源码分析 #视图 class login (View): pass #路由 url(r'^books/$', views.login.as_view()) #阅读源码: #左侧工程栏--- ...

  3. Django rest framework框架——APIview源码分析

    一.什么是rest REST其实是一种组织Web服务的架构,而并不是我们想象的那样是实现Web服务的一种新的技术,更没有要求一定要使用HTTP.其目标是为了创建具有良好扩展性的分布式系统. 可用一句话 ...

  4. cbv+resful+APIView源码分析

    CBV源码分析 1概念:什么是cbv和fbv 已经什么是API class bass View ---基于类的视图 function bass View ---基于函数的视图 API(Applicat ...

  5. 探索drf执行流程之APIView源码分析

    Django REST framework 简介 现在新一代web应用都开始采用前后端分离的方式来进行,淘汰了以前的服务器端渲染的方式.而实现前后端分离是通过Django REST framework ...

  6. drf框架,restful接口规范,源码分析

    复习 """ 1.vue如果控制html 在html中设置挂载点.导入vue.js环境.创建Vue对象与挂载点绑定 2.vue是渐进式js框架 3.vue指令 {{ }} ...

  7. django Rest Framework----APIView 执行流程 APIView 源码分析

    在django—CBV源码分析中,我们是分析的from django.views import View下的执行流程,这篇博客我们介绍django Rest Framework下的APIView的源码 ...

  8. drf的基本使用、APIView源码分析和CBV源码拓展

    cbv源码拓展 扩展,如果我在Book视图类中重写dispatch方法 -可以实现,在get,post方法执行之前或者之后执行代码,完成类似装饰器的效果 def dispatch(self, requ ...

  9. CBV和APIView源码分析

    CBV源码分析 查看源码的方式,先查看自身,没有去找父类,父类没有就去找父父类... 自己定义的类 class Author(View): def get(self,request): back_di ...

随机推荐

  1. 企业选择CRM系统的要点

    经过十数年的发展,CRM客户管理系统在企业当中开始家喻户晓,它的普及性也越来越高.管理者们也纷纷意识到CRM系统--这种企业管理工具带来的巨大好处.既然CRM给企业带来这么大的好处,那么企业该怎么选择 ...

  2. Canal和Otter讨论二(原理与实践)

    上次留下的问题 问题一: 跨公网部署Otter 参考架构图 解析 ​ a. 数据涉及网络传输,S/E/T/L几个阶段会分散在2个或者更多Node节点上,多个Node之间通过zookeeper进行协同工 ...

  3. Maven知识点一览

    Maven 介绍和搭建 介绍 Maven是基于项目对象模型(POM),可以通过一小段描述信息来管理项目的构建,报告,和文档的软件项目管理工具. 环境搭建 网址:https://maven.apache ...

  4. Linux useradd 命令介绍

    Linux useradd 命令介绍 作者: Alan Formy-duval 译者: LCTT Brooke Lau | 2020-01-06 22:58 使用 useradd 命令来添加用户(并且 ...

  5. C# 技术体系简介

    C# 语言 .Net Framwork .NET Core winform界面编程 WPF开发经验,熟悉C/S架构产品开发及架构和设计 DevExpress界面框架(其实就是基于微软的 Winform ...

  6. 03-用三种方法设置CentOS7使用代理服务器上网

    一.永久设置 编辑配置文件 vi /etc/profile 在文件后添加以下内容: export http_proxy='http://代理服务器IP:端口号' export https_proxy= ...

  7. 10.15 wget:命令行下载工具

    wget命令   用于从网络上下载某些资料,该命令对于能够连接到互联网的Linux系统的作用非常大,可以直接从网络上下载自己所需要的文件. wget的特点如下: 支持断点下载功能. 支持FTP和HTT ...

  8. 利用TortoiseGit向Github上传文件

    利用TortoiseGit向Github上传文件 第一步:建一个新文件夹,作为本地仓库 第二步:右键选择设置为版本库 若弹出,确认即可 重新打开改文件,会发现多了一个绿色的小勾 在文件夹中会自动生成一 ...

  9. Kali Linux 2021.2 发布 (Kaboxer, Kali-Tweaks, Bleeding-Edge & Privileged Ports)

    Kali Linux 简介 Kali Linux 是基于 Debian 的 Linux 发行版,旨在进行高级渗透测试和安全审核.Kali Linux 包含数百种工具,可用于各种信息安全任务,例如渗透测 ...

  10. 通过Maven打jar包&运行

    运行命令:java -jar [包名] https://www.cnblogs.com/jinjiyese153/p/9374015.html