从这一点来说,我们将真正开始覆盖REST框架的核心。 我们来介绍一些基本的构建块。
Request objects
REST框架引入了一个扩展常规HttpRequest的Request对象,并提供了更灵活的请求解析。Request对象的核心功能是request.data属性,它与request.POST类似,但对于使用Web API更加有用。
request.POST # 只处理表单数据。 只适用于'POST'方法。
request.data # 处理任意数据。 适用于“POST”,“PUT”和“PATCH”方法。
Response objects
REST框架还引入了一个Response对象,它是一种TemplateResponse类型,它接受未呈现的内容并使用内容协商来确定返回给客户端的正确内容类型。
return Response(data) # 按照客户端的要求渲染到内容类型。
Status codes
在视图中使用数字HTTP状态代码并不总是显而易见的阅读,并且如果错误代码错误,很容易不注意。 REST框架为每个状态代码提供更明确的标识符,例如状态模块中的HTTP_400_BAD_REQUEST。 这是一个好主意,而不是使用数字标识符。
Wrapping API views
REST框架提供了两个可用于编写API视图的包装器。
1. 用于处理基于视图的函数的@api_view装饰器。
2. APIView类用于处理基于类的视图。
这些包装提供了一些功能,例如确保在视图中接收Request实例,并向Response对象添加上下文,以便可以执行内容协商。
这些包装器还提供了一些行为,例如在适当的时候返回405方法不允许的响应,以及处理访问具有格式错误的输入的request.data时发生的任何ParseError异常。
重构视图
from rest_framework import status
from rest_framework.decorators import api_view
from rest_framework.response import Response
from snippets.models import Snippet
from snippets.serializers import SnippetSerializer
@api_view(['GET', 'POST'])
def snippet_list(request):
"""
List all code snippets, or create a new snippet.
"""
if request.method == 'GET':
snippets = Snippet.objects.all()
serializer = SnippetSerializer(snippets, many=True)
return Response(serializer.data)
elif request.method == 'POST':
serializer = SnippetSerializer(data=request.data)
if serializer.is_valid():
serializer.save()
return Response(serializer.data, status=status.HTTP_201_CREATED)
return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
我们的实例视图是对前一个示例的改进。 它更简洁一些,现在的代码感觉和我们使用Forms API非常相似。 我们还使用了指定的状态码,这使得响应的含义更加明显。
以下是views.py模块中单个代码片段的视图。
@api_view(['GET', 'PUT', 'DELETE'])
def snippet_detail(request, pk):
"""
Retrieve, update or delete a code snippet.
"""
try:
snippet = Snippet.objects.get(pk=pk)
except Snippet.DoesNotExist:
return Response(status=status.HTTP_404_NOT_FOUND)
if request.method == 'GET':
serializer = SnippetSerializer(snippet)
return Response(serializer.data)
elif request.method == 'PUT':
serializer = SnippetSerializer(snippet, data=request.data)
if serializer.is_valid():
serializer.save()
return Response(serializer.data)
return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
elif request.method == 'DELETE':
snippet.delete()
return Response(status=status.HTTP_204_NO_CONTENT)
这应该都感到非常熟悉 - 这与使用常规Django视图没有多大区别。
请注意,我们不再明确地将我们的请求或响应绑定到给定的内容类型。 request.data可以处理传入的json请求,但也可以处理其他格式。 同样,我们使用数据返回响应对象,但允许REST框架将响应呈现给我们正确的内容类型。
为了利用我们的响应不再被硬连接到单个内容类型的事实,让我们添加对格式后缀的支持到我们的API端点。 使用格式后缀给了我们明确引用给定格式的URL,并且意味着我们的API将能够处理诸如http://example.com/api/items/4.json之类的URL。
首先向这两个视图添加一个格式关键字参数,就像这样。
def snippet_list(request, format=None):
and
def snippet_detail(request, pk, format=None):
现在稍微更新urls.py文件,除了现有的URL之外,还附加一组format_suffix_patterns。
from django.conf.urls import url
from rest_framework.urlpatterns import format_suffix_patterns
from snippets import views
urlpatterns = [
url(r'^snippets/$', views.snippet_list),
url(r'^snippets/(?P<pk>[0-9]+)$', views.snippet_detail),
]
urlpatterns = format_suffix_patterns(urlpatterns)
我们不一定需要添加这些额外的url模式,但它给了我们一个简单,干净的方式来引用一个特定的格式。
继续从命令行测试API,就像我们在教程第1部分中所做的那样。尽管如果我们发送无效的请求,但是我们已经有了更好的错误处理,所有的工作都非常类似。
和以前一样,我们可以得到所有片段的列表。
http http://127.0.0.1:8000/snippets/
HTTP/1.1 200 OK
...
[
{
"id": 1,
"title": "",
"code": "foo = \"bar\"\n",
"linenos": false,
"language": "python",
"style": "friendly"
},
{
"id": 2,
"title": "",
"code": "print \"hello, world\"\n",
"linenos": false,
"language": "python",
"style": "friendly"
}
]
我们可以通过使用Accept头来控制返回的响应的格式:
http http://127.0.0.1:8000/snippets/ Accept:application/json # Request JSON
http http://127.0.0.1:8000/snippets/ Accept:text/html # Request HTML
或者通过附加格式后缀:
http http://127.0.0.1:8000/snippets.json # JSON suffix
http http://127.0.0.1:8000/snippets.api # Browsable API suffix
同样,我们可以使用Content-Type头来控制我们发送的请求的格式。
# POST using form data
http --form POST http://127.0.0.1:8000/snippets/ code="print 123"
{
"id": 3,
"title": "",
"code": "print 123",
"linenos": false,
"language": "python",
"style": "friendly"
}
# POST using JSON
http --json POST http://127.0.0.1:8000/snippets/ code="print 456"
{
"id": 4,
"title": "",
"code": "print 456",
"linenos": false,
"language": "python",
"style": "friendly"
}
如果您在上面的http请求中添加了–debug开关,您将能够在请求标头中看到请求类型。