文章目录
- 1. http请求响应
- 1.1. 请求与响应
- 1.1.1 Request
- 1.1.1.1 常用属性
- 1).data
- 2).query_params
- 3)request._request
- 基本使用
- 1.1.2 Response
- 1.1.2.1 构造方式
- 1.1.2.2 response对象的属性
- 1).data
- 2).status_code
- 3).content
- 1.1.2.3 状态码
- 1)信息告知 - 1xx
- 2)成功 - 2xx
- 3)重定向 - 3xx
- 4)客户端错误 - 4xx
- 5)服务器错误 - 5xx
- 1. 视图
- 1.2 普通视图
- 1.2.1 2个视图基类
- 1.2.1.1 APIView基本视图类
- 1.2.1.2 GenericAPIView[通用视图类]
- get_serializer(self, *args, \**kwargs)
- 1.2.2 5个视图扩展类
- 1)ListModelMixin
- 2)CreateModelMixin
- 3)RetrieveModelMixin
- 4)UpdateModelMixin
- 5)DestroyModelMixin
- 1.2.3 9个视图子类
- 1)CreateAPIView
- 2)ListAPIView
- 3)RetrieveAPIView
- 4)DestoryAPIView
- 5)UpdateAPIView
- 6)ListCreateAPIView
- 7)RetrieveUpdateAPIView
- 8)RetrieveDestoryAPIView
- 9)RetrieveUpdateDestoryAPIView
- 1.3 视图集ViewSet
- 1.3.1 常用视图集父类
- 1) ViewSet
- 2)GenericViewSet
- 3)ModelViewSet
- 4)ReadOnlyModelViewSet
- 2. 路由Routers
- 2.1 使用方法
- 2.2 视图集中附加action的声明
- 2.3 路由router形成URL的方式
什么时候声明的序列化器需要继承序列化器基类Serializer,什么时候继承模型序列化器类ModelSerializer?
继承序列化器类Serializer字段声明验证添加/保存数据功能
继承模型序列化器类ModelSerializer字段声明[可选,看需要]Meta声明验证添加/保存数据功能[可选]
看数据是否从mysql数据库中获取,如果是则使用ModelSerializer,不是则使用Serializer
1. http请求响应
drf除了在数据序列化部分简写代码以外,还在视图中提供了简写操作。所以在django原有的django.views.View类基础上,drf封装了多个视图子类出来提供给我们使用。
Django REST framwork 提供的视图的主要作用:
- 控制序列化器的执行(检验、保存、转换数据)
- 控制数据库查询的执行
- 调用请求类和响应类[这两个类也是由drf帮我们再次扩展了一些功能类。]
为了方便我们学习,所以先创建一个子应用req
python manage.py startapp req
注册子引用:
INSTALLED_APPS = ['django.contrib.admin','django.contrib.auth','django.contrib.contenttypes','django.contrib.sessions','django.contrib.messages','django.contrib.staticfiles','rest_framework','students','sers', # 序列化器"school", # 序列化器嵌套'req', # 请求与响应
]
注册路由
# 子应用路由
from django.urls import path
from . import views
urlpatterns = []# 总路由
from django.contrib import admin
from django.urls import path, includeurlpatterns = [path('admin/', admin.site.urls),path('students/', include("students.urls")),path('sers/', include("sers.urls")),path('school/', include("school.urls")),path("req/", include("req.urls")),
]
1.1. 请求与响应
内容协商:drf在django原有的基础上,新增了一个request对象继承到了APIVIew视图类,并在django原有的HttpResponse响应类的基础上实现了一个子类rest_framework.response.Response响应类。这两个类,都是基于内容协商来完成数据的格式转换的。
request->parser解析类->识别客户端请求头中的Content-Type来完成数据转换成->类字典(QueryDict,字典的子类)
response->renderer渲染类->识别客户端请求头的"Accept"来提取客户端期望的返回数据格式,-> 转换成客户端的期望格式数据
1.1.1 Request
REST framework 传入视图的request对象不再是Django默认的HttpRequest对象,而是REST framework提供的扩展了HttpRequest类的Request类的对象。
REST framework 提供了Parser解析器,在接收到请求后会自动根据Content-Type指明的请求数据类型(如JSON、表单等)将请求数据进行parse解析,解析为类字典[QueryDict]对象保存到Request对象中。
Request对象的数据是自动根据前端发送数据的格式进行解析之后的结果。
无论前端发送的哪种格式的数据,我们都可以以统一的方式读取数据。
1.1.1.1 常用属性
1).data
request.data
返回解析之后的请求体数据。类似于Django中标准的request.POST
和 request.FILES
属性,但提供如下特性:
- 包含了解析之后的文件和非文件数据
- 包含了对POST、PUT、PATCH请求方式解析后的数据
- 利用了REST framework的parser解析器,不仅支持表单类型数据,也支持JSON数据
2).query_params
query_params,查询参数,也叫查询字符串(query string )
request.query_params
与Django标准的request.GET
相同,只是更换了更正确的名称而已。
3)request._request
获取django封装的Request对象
基本使用
视图代码:
from django.views import View
from django.http.response import HttpResponse
from django.http.request import HttpRequest
from django.core.handlers.wsgi import WSGIRequest
class ReqView(View):def get(self,request):print(request)return HttpResponse("ok")"""
默认情况下, 编写视图类时,如果继承的是django内置的django.view.View视图基类,
则视图方法中得到的request对象,是django默认提供的django.core.handlers.wsgi.WSGIRequest
WSGIRequest这个请求处理对象,无法直接提供的关于json数据数据处理。
在编写api接口时很不方便,所以drf为了简写这块内容,在原来的HttpRequest的基础上面,新增了一个Request对象
这个Request对象是单独声明的和原来django的HttpRequest不是父子关系。
同时注意:要使用drf提供的Request请求处理对象,必须在编写视图类时继承drf提供的视图基类from rest_framework.views import APIView如果使用drf提供的视图基类APIView编写类视图,则必须使用来自drf提供的Request请求对象和Response响应对象
"""
from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework import status
class ReqAPIView(APIView):def get(self,request):# rest_framework.request.Request对象print(request) # <rest_framework.request.Request: GET '/req/req2?name=xiaoming&age=17&lve=swim&lve=code'># 获取查询字符串print(request.query_params)# 没有参数情况下: <QueryDict: {}># 有参数的情况下: <QueryDict: {'name': ['xiaoming'], 'age': ['17'], 'lve': ['swim', 'code']}># 所以,request.query_params的返回值操作和原来在django里面是一模一样的print(request.query_params.get("name")) # xiaomingprint(request.query_params.getlist("lve")) # ['swim', 'code']return Response("ok")def post(self, request):# 获取请求体print(request.data) # {'name': 'xiaoming', 'age': 16, 'lve': ['swim', 'code']}"""直接从请求体中提取数据转# 客户端如果上传了json数据,直接返回字典{'name': '灰太狼', 'age': 20, 'sex': 1, 'classmate': '301', 'description': '我还会再回来的~'}# 客户端如果上传了表单数据,直接返回QueryDict<QueryDict: {'name': ['xiaohui'], 'age': ['18']}>"""print(request.FILES) # 获取上传文件列表# 要获取django原生提供的HttpRequest对象,可以通过request._request来获取到print(request._request.META.get("Accept")) # 当值为None时,drf默认在响应数据时按json格式返回# response = Response(data="not ok", status=204, headers={"Company":"Oldboy"})response = Response(data="not ok", status=status.HTTP_400_BAD_REQUEST, headers={"Company":"Oldboy"})return response
1.1.2 Response
rest_framework.response.Response
REST framework提供了一个响应类Response
,使用该类构造响应对象时,响应的具体数据内容会被转换(renderer渲染器)成符合前端需求的类型。
REST framework提供了Renderer
渲染器,用来根据请求头中的Accept
(接收数据类型声明)来自动转换响应数据到对应格式。如果前端请求中未进行声明Accept,则会采用Content-Type方式处理响应数据,我们可以通过配置来修改默认响应格式。
可以在rest_framework.settings查找所有的drf默认配置项
REST_FRAMEWORK = {'DEFAULT_RENDERER_CLASSES': ( # 默认响应渲染类'rest_framework.renderers.JSONRenderer', # json渲染器,返回json数据'rest_framework.renderers.BrowsableAPIRenderer', # 浏览器API渲染器,返回调试界面)
}
1.1.2.1 构造方式
Response(data, status=None, template_name=None, headers=None, content_type=None)
drf的响应处理类和请求处理类不一样,Response就是django的HttpResponse响应处理类的子类。
data
数据不要是render处理之后的数据,只需传递python的内建类型数据即可,REST framework会使用renderer
渲染器处理data
。
data
不能是复杂结构的数据,如Django的模型类对象,对于这样的数据我们可以使用Serializer
序列化器序列化处理后(转为了Python字典类型)再传递给data
参数。
参数说明:
data
: 为响应准备的序列化处理后的数据;status
: 状态码,默认200;template_name
: 模板名称,如果使用HTMLRenderer
时需指明;headers
: 用于存放响应头信息的字典;content_type
: 响应数据的Content-Type,通常此参数无需传递,REST framework会根据前端所需类型数据来设置该参数。
1.1.2.2 response对象的属性
1).data
传给response对象的序列化后,但尚未render处理的数据
2).status_code
状态码的数字
3).content
经过render处理后的响应数据
1.1.2.3 状态码
为了方便设置状态码,REST framewrok在rest_framework.status
模块中提供了常用http状态码的常量。
1)信息告知 - 1xx
HTTP_100_CONTINUE
HTTP_101_SWITCHING_PROTOCOLS
2)成功 - 2xx
HTTP_200_OK
HTTP_201_CREATED
HTTP_202_ACCEPTED
HTTP_203_NON_AUTHORITATIVE_INFORMATION
HTTP_204_NO_CONTENT
HTTP_205_RESET_CONTENT
HTTP_206_PARTIAL_CONTENT
HTTP_207_MULTI_STATUS
3)重定向 - 3xx
HTTP_300_MULTIPLE_CHOICES
HTTP_301_MOVED_PERMANENTLY
HTTP_302_FOUND
HTTP_303_SEE_OTHER
HTTP_304_NOT_MODIFIED
HTTP_305_USE_PROXY
HTTP_306_RESERVED
HTTP_307_TEMPORARY_REDIRECT
4)客户端错误 - 4xx
HTTP_400_BAD_REQUEST
HTTP_401_UNAUTHORIZED
HTTP_402_PAYMENT_REQUIRED
HTTP_403_FORBIDDEN
HTTP_404_NOT_FOUND
HTTP_405_METHOD_NOT_ALLOWED
HTTP_406_NOT_ACCEPTABLE
HTTP_407_PROXY_AUTHENTICATION_REQUIRED
HTTP_408_REQUEST_TIMEOUT
HTTP_409_CONFLICT
HTTP_410_GONE
HTTP_411_LENGTH_REQUIRED
HTTP_412_PRECONDITION_FAILED
HTTP_413_REQUEST_ENTITY_TOO_LARGE
HTTP_414_REQUEST_URI_TOO_LONG
HTTP_415_UNSUPPORTED_MEDIA_TYPE
HTTP_416_REQUESTED_RANGE_NOT_SATISFIABLE
HTTP_417_EXPECTATION_FAILED
HTTP_422_UNPROCESSABLE_ENTITY
HTTP_423_LOCKED
HTTP_424_FAILED_DEPENDENCY
HTTP_428_PRECONDITION_REQUIRED
HTTP_429_TOO_MANY_REQUESTS
HTTP_431_REQUEST_HEADER_FIELDS_TOO_LARGE
HTTP_451_UNAVAILABLE_FOR_LEGAL_REASONS
5)服务器错误 - 5xx
HTTP_500_INTERNAL_SERVER_ERROR
HTTP_501_NOT_IMPLEMENTED
HTTP_502_BAD_GATEWAY
HTTP_503_SERVICE_UNAVAILABLE
HTTP_504_GATEWAY_TIMEOUT
HTTP_505_HTTP_VERSION_NOT_SUPPORTED
HTTP_507_INSUFFICIENT_STORAGE
HTTP_511_NETWORK_AUTHENTICATION_REQUIRED
另外创建一个子应用
python manage.py startapp demo
注册子应用
INSTALLED_APPS = ['django.contrib.admin','django.contrib.auth','django.contrib.contenttypes','django.contrib.sessions','django.contrib.messages','django.contrib.staticfiles','rest_framework','students','sers', # 序列化器"school", # 序列化器嵌套'req', # 请求与响应'demo', # 视图
]
总路由,代码:
from django.contrib import admin
from django.urls import path, includeurlpatterns = [path('admin/', admin.site.urls),path('students/', include("students.urls")),path('sers/', include("sers.urls")),path('school/', include("school.urls")),path("req/", include("req.urls")),path("demo/", include("demo.urls")),
]
子应用路由,代码:
from django.urls import path
from . import viewsurlpatterns = []
1. 视图
Django REST framwork 提供的视图的主要作用:
- 控制序列化器的执行(检验、保存、转换数据)
- 控制数据库模型的操作
1.2 普通视图
REST framework 提供了众多的通用视图基类与扩展类,以简化视图的编写。
1.2.1 2个视图基类
1.2.1.1 APIView基本视图类
rest_framework.views.APIView
APIView
是REST framework提供的所有视图类的基类,继承自Django的View
父类。
APIView
与View
的不同之处在于:
-
传入到视图方法中的是REST framework的
Request
对象,而不是Django的HttpRequeset
对象; -
视图方法可以返回REST framework的
Response
对象,视图会为响应数据设置(renderer)符合前端期望要求的格式; -
任何
APIException
异常都会被捕获到,并且处理成合适格式的响应信息返回给客户端;django 的View中所有异常全部以HTML格式显示
drf的APIVIew或者APIView的子类会自动根据客户端的Accept进行错误信息的格式转换。
-
重新声明了一个新的as_view方法并在dispatch()进行路由分发前,会对请求的客户端进行身份认证、权限检查、流量控制。
APIView除了继承了View原有的属性方法意外,还新增了类属性:
- authentication_classes 列表或元组,身份认证类
- permissoin_classes 列表或元组,权限检查类
- throttle_classes 列表或元祖,流量控制类
在APIView
中仍以常规的类视图定义方法来实现get() 、post() 或者其他请求方式的方法。
序列化器,demo/serializers.py,代码:
from rest_framework import serializers
from stuapi.models import Studentclass StudentModelSerializer(serializers.ModelSerializer):class Meta:model = Studentfields = "__all__"extra_kwargs = {"age": {"max_value": 25,"error_messages": {"max_value": "年龄不能超过25岁!",}}}
视图代码:
from rest_framework import status
from rest_framework.views import APIView
from rest_framework.response import Response
from stuapi.models import Student
from .serializers import StudentModelSerializer
"""
GET /demo/students/ 获取所有学生信息
POST /demo/students/ 添加一个学生信息 GET /demo/students/<pk> 获取一个学生信息
PUT /demo/students/<pk> 更新一个学生信息
DELETE /demo/students/<pk> 删除一个学生信息
"""# Create your views here.
class StudentAPIView(APIView):def get(self,request):"""获取所有学生信息"""# 1. 从数据库中读取学生列表信息student_list = Student.objects.all()# 2. 实例化序列化器,获取序列化对象serializer = StudentModelSerializer(instance=student_list, many=True)# 3. 转换数据并返回给客户端return Response(serializer.data)def post(self,request):"""添加一条数据"""# 1. 获取客户端提交的数据,实例化序列化器,获取序列化对象serializer = StudentModelSerializer(data=request.data)# 2. 反序列化[验证数据、保存数据到数据库]serializer.is_valid(raise_exception=True)serializer.save()# 3. 返回新增的模型数据给客户单return Response(serializer.data, status=status.HTTP_201_CREATED)class StudentInfoAPIView(APIView):def get(self,request, pk):"""获取一条数据"""# 1. 使用pk作为条件获取模型对象try:student = Student.objects.get(pk=pk)except Student.DoesNotExist:return Response(status=status.HTTP_404_NOT_FOUND)