Django REST framework 学习笔记(二)
Request对象
- REST framework 引入了一个
Request
对象,它是对HttpRequest
的扩展,并提供灵活的请求解析 Request
对象的核心功能是request.data
,它类似于request.POST
,但对于使用Web API更加有用
request.POST # 只能操作 form表单 数据,只能用于 'POST' 方法
request.data # 可以操作任意的数据,并且能用于 'POST'、'PUT'、'PATCH' 方法
Response对象
- REST framework 还引入了一个
Response
对象,它是一种TemplateResponse
对象 - 它能够使用协商好的类型,根据客户端请求的内容类型,呈现给客户端该类型的内容
- 例如:客户端请求
json
类型的数据,则呈现给客户端json
类型数据
return Response(data) # 根据客户端的请求呈现内容类型
状态码
- 使用数字HTTP状态码并不能总是正确的显示出读数,如果代码是错误的的话
- REST framework 为每个状态码提供了专门的标识符,放在了
status
模块中 - 例如:
status.HTTP_400_BAD_REQUEST
,表示状态码400
包装API视图
REST framework 提供了两个用于编写API视图的包装器
@api_view
是处理基于函数方法的API视图的一个装饰器APIView
是基于类的API视图
这些包装器提供了一些功能,例如:确保Request
在视图中能接收到实例对象,以及向Response
对象添加内容以呈现给客户端
并且提供了一些动作行为,例如:在适当的时候返回405 Method Not Allowed
响应,还有当访问request.data
出现输入格式错误时抛出ParseError
异常
使用@api_view编写API视图
在上一篇文章中的项目案例中,修改 views.py
文件,我们不再使用JSONResponse
,所以用下面的代码替换掉文件的内容
from django.http import HttpResponse
from rest_framework import status
from rest_framework.decorators import api_view
from rest_framework.response import Response
from .models import Snippet
from .serializers import SnippetSerializer
@api_view(['GET', 'POST'])
def snippet_list(request, format=None):
"""
列出所有代码段,或创建新代码段。
"""
if request.method == 'GET':
snippets = Snippet.objects.all()
serializer = SnippetSerializer(snippets,