从这一点开始,我们将真正开始覆盖REST框架的核心。我们来介绍几个基本的构建块。
请求对象(Request object)
REST框架引入了Request对象,它继承自普通的HttpRequest,但能够更加灵活的解析收到的请求。Request对象的核心功能是request.data属性,这与request.POST很像,但对我们的Web API来说,更加的有用。
request.POST # 只能处理表单(form)数据,只能处理“POST”方法.
request.data # 处理任意数据.可以处理'POST', 'PUT' 和 'PATCH'方法.
响应对象(Response object)
REST框架还引入了一个Response对象,是一种TemplateResponse,它采用未呈现的内容,通过内容协商来确定正确的内容类型以返回给客户端。
return Response(data) # 根据客户端的要求,把内容,生成对应的形式.
状态码(Status codes)
在您的视图中使用数字HTTP状态代码并不利于代码的阅读,如果写错代码,也不很容易就不发现到。REST框架为每一个状态码更明确的标识符,如HTTP_400_BAD_REQUEST中的status模块。相对于使用数字标识符更好。
包装API视图(wrapping API views)
REST框架提供了两种编写API视图的封装。
@api_view装饰器,基于方法的视图。
继承APIView类,基于类的视图。
这些视图封装提供了一些功能,例如确保你的视图能够Request接收实例,并将上下文添加到Response对象,使得 内容协商(content negotiation) 可以正常的运作。
试图封装,内置了一些行为,比如:在遇到错误请求时,自动响应405 Method Not Allowed,在处理request.data时,因为输入的格式不正确,而发生的任何ParseError异常,
把它拉在一起
现在,让我们开始使用这些新的组件来写几个视图。
我们不再需要在views.py文件中使用JSONResponse类,所以可以删除它。然后,我们可以稍微重构我们的代码。
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):
"""
列出所有的代码片段(snippets),或者创建一个代码片段(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,你会发现,它们非常的相识。我们也用了命名式的状态码,这让响应的状态,易于阅读。
以下是snippet的详细视图,它是views.py模块中。
@api_view(['GET', 'PUT', 'DELETE'])
def snippet_detail(request, pk):
"""
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/Response的内容类型。request.data会自行处理输入的json请求,当然,也能处理别的格式。同样的,我们只需返回响应对象以及数据,REST framework会帮我们,将响应内容,渲染(render)成正确的格式。
向我们的网址添加可选的格式后缀
现在,我们的响应,不再硬性绑定在,某一种返回格式上,利用这点优势,我们可以为API端,添加格式的后缀。使用格式后缀,可以定制我们的URLs,使它明确的指向指定的格式,这意味着,我们的API可以处理一些URLs,类似这样的格式http://example.com/api/items/4.json。
首先,需要添加一个format关键字参数,如下所示:
def snippet_list(request, format=None):
还有:
def snippet_detail(request, pk, format=None):
然后对urls.py文件,做一些修改。在现有的urls基础上,追加一套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[0-9]+)$', views.snippet_detail),
]
urlpatterns = format_suffix_patterns(urlpatterns)
我们不需要逐一地,添加对格式支持的 url 样式(patterns),这是一个简洁的方法,来快速支持特定的格式。
效果如何
接着,我们可以从命令行中测试我们的API,在教程第1部分中的操作一样。尽管我们对一些无效的请求,提供了很好的处理,但仍然没有太大的改变。
我们可以获取所有snippet的列表,就跟之前一样。
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"
}
]
我们也可以控制响应内容的格式,通过Http中的Accept头:
http http://127.0.0.1:8000/snippets/ Accept:application/json # 请求 JSON
http http://127.0.0.1:8000/snippets/ Accept:text/html # 请求 HTML
我们也可以控制响应内容的格式,通过Http中的
http http://127.0.0.1:8000/snippets.json # JSON 后缀
http://127.0.0.1:8000/snippets.api # 可视化 API 后缀
同样的,我们可以控制,发送的请求类型,通过http中的用Content-Type头(header):
# 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"
}
如果您--debug向上述http请求添加切换器,则可以在请求标头中查看请求类型。
现在,在Web浏览器中打开API,访问http://127.0.0.1:8000/snippets/。
可视化
由于 API 选择响应格式,是基于客户端发起的请求,因此,当接收到来着浏览器的请求时,会默认以HTML格式来描述数据。这让API能够返回,可以网页浏览(web-browsable)的HTML表现。
拥有网页浏览(web-browsable)的API,实在是非常的有用,使得开发和使用API,变成非常便利。这也大大降低了使用壁垒,让其它开发者,更加容易的查看和使用,你的API。
如需了解更多,有关可视化API的特性,以及如何定制,可以查阅专题:可视化API