教程2-请求和响应(Requests and Response)-DRF(Django REST framework)中文文档

返回目录
上一节: 序列化器
从现在开始我们将要真正涉及到REST framework的核心部分, 让我们先介绍几个基本构建块。

Request 对象

REST框架引入了一个Request对象,该对象扩展了常规的HttpRequest,并提供了更灵活的请求解析。Request对象中的一个核心功能就是request.data属性,与request.POST十分类似,但是在使用Web API的时候更加有用。

    request.POST    # 只能处理数据, 只在POST请求时起作用。
    request.data    # 处理任意数据,在POST, PUT, PATCH请求下都起作用

Response 对象

REST framework 也提供了Response对象,它是SimpleTemplateResponse的一个子类,接收未经渲染的内容,并根据前端要求的格式转换成正确格式内容,返回给客户端。

return Response(data)  # Renders to content type as requested by the client.

状态码

在视图中使用数字状态码读起来并不是很清晰,并且很容易将状态码用混,REST framework 提供了更明确定义的状态码,比如status模块中的HTTP_400_BAD_REQUEST,使用这些状态码而不是使用纯数字的状态码是更好的选择。

包装API 视图

REST framework提供了两种包装视图API的方法。
1. @api_view装饰器可以使用在基于函数的视图上。
2. APIView类可以使用在基于类的视图上。
他们提供了一些使用的方法,比如确保视图函数接收到了Request实例,并且给Response对象添加上下文,以确保内容正确的渲染。
包装方法还会在合适的时候响应405 Method Not Allowed,也会在输入的数据不完整的时候,处理ParseError异常。

组合到一起

OK!现在开始使用这些新组件写几个视图函数吧。
我们在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):
    """
    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)

我们的视图较之前的版本有了一些升级,更加简洁,而且如果了解Form的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 framework将内容渲染成正确的类型。

给URL添加可选的格式化后缀

在API的最后,添加格式化后缀,可以让我们体验到不再将响应与唯一的内容格式绑定的好处,使用格式化后缀可以让我们通过url来明确地指定需要返回的类型,这意味着你可以这样写urlhttp://example.com/api/items/4.json
首先在视图中添加format关键字参数。

def snippet_list(request, format=None):

还有:

def snippet_detail(request, pk, format=None):

现在稍微修改snippets/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)

我们不一定需要添加这些额外的urlpatterns,但它为我们提供了一种简单,干净的方式来引用特定的格式。

效果

尽管使用命令行工具来测试我们的API吧,一切看起来和之前一样,虽然我们发送无效请求的话,会有以下更好的错误处理。
我们能获取到所有的代码片段,和之前一样。

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选项, 你就可以在请求头中看到请求的类型了。
现在在浏览器中输入http://127.0.0.1:8000/snippets/ 来打开API。

浏览功能

由于API根据客户端请求中指定的格式响应内容类型,当使用浏览器请求资源的时候,API会默认将资源渲染成HTML的格式,得到一个完整的可浏览的HTML表现形式。
拥有可浏览的API时一个十分有用的功能,使开发和使用API变得十分容易,同时也降低了其他检查或使用你的API的开发者的准入门槛。
查看(The Browsable API )获取可浏览API的更多信息,并了解如果自定义。

下一步?

在教程3中,我们要学习基于类的视图,并了解generic view怎样节约我们的代码量。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,839评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,543评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,116评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,371评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,384评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,111评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,416评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,053评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,558评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,007评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,117评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,756评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,324评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,315评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,539评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,578评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,877评论 2 345

推荐阅读更多精彩内容