Django DRF 请求与响应
文章目录
-
- 1 Request
-
- 1.1 常用属性
- 1.2 控制前端传入的编码格式
- 2 Response
-
- 2.1 主要属性
- 2.2 控制展示格式
1 Request
-
REST framework 传入视图的request对象不再是Django默认的HttpRequest对象，而是REST framework提供的扩展了HttpRequest类的Request类的对象。
-
REST framework 提供了Parser解析器，在接收到请求后会自动根据Content-Type指明的请求数据类型（如JSON、表单等）将请求数据进行parse解析，解析为类字典[QueryDict]对象保存到Request对象中。
-
Request对象的数据是自动根据前端发送数据的格式进行解析之后的结果。
-
无论前端发送的哪种格式的数据，都可以以统一的方式读取数据。
1.1 常用属性
data
request.data 返回解析之后的请求体数据。类似于Django中标准的 request.POST 和 request.FILES 属性
- 包含了解析之后的文件和非文件数据
- 包含了对POST、PUT、PATCH请求方式解析后的数据
- 利用了REST framework的parsers解析器，不仅支持表单类型数据，也支持JSON数据
query_params
request.query_params与Django标准的request.GET相同
1.2 控制前端传入的编码格式
前端传入的数据默认为 urlencoded，form-data，json
方法一
同过修改配置文件来控制前端传入的编码格式。此方式为全局修改
REST_FRAMEWORK = {
# 能够接受前端的编码格式
'DEFAULT_PARSER_CLASSES': [
'rest_framework.parsers.JSONParser', # 解析类，能够解析 json
'rest_framework.parsers.FormParser', # 能够解析 urlencoded
'rest_framework.parsers.MultiPartParser', # 能够解析 form-data
],
}
方法二
在视图类中控制，局部修改，例如将 json 格式解析去除，就不能在通过 json 数据进行操作了，
from rest_framework.parsers import JSONParser, MultiPartParser, FormParser
class BookView(MyView):
parser_classes = [JSONParser, MultiPartParser, FormParser]
...
2 Response
需要从该位置导入：rest_framework.response.Response
REST framework提供了一个响应类Response，使用该类构造响应对象时，响应的具体数据内容会被转换（render渲染）成符合前端需求的类型。
REST framework提供了Renderer 渲染器，用来根据请求头中的Accept（接收数据类型声明）来自动转换响应数据到对应格式。如果前端请求中未进行Accept声明，则会采用默认方式处理响应数据，我们可以通过配置来修改默认响应格式。
可以在rest_framework.settings查找所有的drf默认配置项
2.1 主要属性
Response(data, status=None, template_name=None, headers=None, content_type=None)
参数说明：
data: 为响应准备的序列化处理后的数据；
status: 状态码，默认200；
template_name: 模板名称，如果使用 HTMLRenderer 时需指明；
headers: 用于存放响应头信息的字典；
content_type: 响应数据的Content-Type，'默认json格式'，通常此参数无需传递，REST framework会根据前端所需类型数据来设置该参数
data
-
data数据不能是 render 处理之后的数据，只需传递 python的内建类型数据即可，REST framework会使用 renderer 渲染器处理 data。 -
data不能是复杂结构的数据，如Django的模型类对象，对于这样的数据我们可以使用Serializer序列化器序列化处理后（转为了Python字典类型）再传递给data参数。
status
为了方便设置状态码，REST framewrok在 rest_framework.status 模块中提供了常用状态码常量。
- 信息告知 - 1xx
HTTP_100_CONTINUE
HTTP_101_SWITCHING_PROTOCOLS
- 成功 - 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
- 重定向 - 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
- 客户端错误 - 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
- 服务器错误 - 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
2.2 控制展示格式
使用 Response 返回时，在浏览器会展示美观的界面如下图所示，在 postman 中是纯 json 格式，我们可以控制在展示的格式。
方法一
在 settings 配置文件中添加如下默认响应渲染类的配置。若将渲染器注销，浏览器上也只展示 json 格式数据。该配置文件是全局生效。
REST_FRAMEWORK = {
'DEFAULT_RENDERER_CLASSES': ( # 默认响应渲染类
'rest_framework.renderers.JSONRenderer', # json渲染器
'rest_framework.renderers.BrowsableAPIRenderer', # 浏览API渲染器
)
}
方法二
除了全局生效，也可以局部生效，在视图类中配置。
from rest_framework.renderers import BrowsableAPIRenderer, JSONRenderer
class BookView(MyView):
renderer_classes = [JSONRenderer, BrowsableAPIRenderer]
...