python Django Rest_Framework框架 Request请求与Response响应详解(图文并茂版)

Django Rest_Framework框架 Request请求与Response响应详解

      • request请求
      • Request对象常用属性
        • data属性
        • query_params属性
        • _request属性
      • Response响应
      • response对象的属性
      • 状态码

request请求

在APIView中仍以常规的类视图定义方法来实现get()、post()或者其他请求方式的方法

但是,DRF在django原有的基础上,新增了一个request对象继承到了APIVIew视图类,并在django原有的HttpResponse响应类的基础上实现了一个子类rest_framework.response.Response响应类

上述的两个类,都是基于内容协商来完成数据格式的转换

内容协商介绍:

  • 客户端与服务端协商请求与响应的数据格式
  • request对象->parser解析器->识别客户端请求头中的Content-Type来完成数据转换成->类字典(QueryDict,字典的子类)
  • response对象->renderer解析器->识别客户端请求头的Accept来获取客户端期望返回的数据格式-> 将数据转换成客户端期望的数据并返回

REST framework传入视图的request对象不再是Django默认的HttpRequest对象,而是REST framework提供的扩展了HttpRequest类的Request类的对象

REST framework 提供了Parser解析器,会自动根据请求头中的Content-Type属性指明的请求数据类型(如JSON、表单等)将请求数据进行parse解析,解析为类字典[QueryDict]对象保存到Request对象中

Request对象常用属性

data属性

request.data返回解析之后的请求体数据。类似于Django中标准的request.POST和 request.FILES属性,还包括如下特性:

  • 包含了解析之后的文件和非文件数据
  • 包含了对POST、PUT、PATCH请求方式解析后的数据
  • 利用了REST framework的parsers解析器,不仅支持表单类型数据,也支持JSON数据

query_params属性

  • request.query_params与Django标准的request.GET相同,获取路由地址传递的参数

_request属性

  • 可以使用request._request获取django封装的Request对象

Response响应

  • REST framework提供了一个响应类Response,使用该类构造响应对象时,响应的具体数据内容会被转换(render渲染器)成符合页面所需的数据类型
  • REST framework提供了Render渲染器,用来根据请求头中的Accept属性(接收数据类型声明)来自动转换响应数据的格式。如果请求中未对Accept属性进行声明,则会采用Content-Type属性格式来处理数据,我们可以通过配置来修改默认响应格式
  • 可以在rest_framework包下面的settings.py中查找所有的DRF默认配置项
DEFAULTS = {
	....
	# 默认的响应渲染类
    'DEFAULT_RENDERER_CLASSES': [
        'rest_framework.renderers.JSONRenderer', # json渲染器,默认返回json数据
        'rest_framework.renderers.BrowsableAPIRenderer',# 浏览器的API渲染器,返回调试界面
    ],
    ....
    }

python Django Rest_Framework框架 Request请求与Response响应详解(图文并茂版)_第1张图片

  • 响应数据格式:
Response(data, status=None, template_name=None, headers=None, content_type=None)

DRF的响应处理类和请求处理类不同,Response就是django中的HttpResponse响应处理类的子类

data只需传递python的内建类型数据即可,REST framework使用render解析器将数据自动处理为内容协商的响应数据类型

data不能为复杂结构的数据,如Django的模型类对象,对于此类数据我们可以使用Serializer序列化器进行处理后(转为了Python字典类型)再传递给data参数

参数说明:

  • data: 为响应准备的序列化处理后的数据
  • status: 状态码
  • template_name: 模板名称,如果需要使用,则需要在HTMLRenderer时需指明,否则为REST framework的默认模板
  • headers: 用于存放响应头信息的字典
  • content_type: 响应数据的Content-Type,通常此参数无需传递,REST framework会根据页面所需类型数据来设置该参数

response对象的属性

  • data属性:传给response对象经序列化器处理后的数据,但尚未经render解析器处理的数据
  • status_code属性:状态码
  • content属性:经过render解析器处理后的响应数据

状态码

  • 为了方便使用响应状态码,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

你可能感兴趣的:(DRF框架,python,DRF,django)