django-rest-framework(2) 请求与响应

最新推荐文章于 2025-08-14 08:54:38 发布

转载最新推荐文章于 2025-08-14 08:54:38 发布 · 87 阅读

0 ·

CC 4.0 BY-SA版权

原文链接：https://my.oschina.net/u/215677/blog/657696

文章标签：

#json #python

本文详细介绍了RESTful API的基本概念及其在实际开发中的应用，通过具体示例展示了如何使用Django REST Framework实现CRUD操作、处理不同格式请求、配置URL路径以及通过HTTP头部控制响应格式。涵盖了从请求对象的使用到响应对象的生成，包括状态码的明确标识、API视图的封装和URL路径的格式化，以及如何在不同场景下灵活处理API请求。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

2019独角兽企业重金招聘Python工程师标准>>>

请求对象

restful api提供了下面了几个方法

HTTP方法	行为	示例
GET	获取所有的资源的信息	http://xx.com/api/orders
GET	获取某个特定的资源的信息	http://xx.com/api/orders/2
POST	创建新的资源	http://xx.com/api/orders
PUT	更新资源	http://xx.com/api/orders/1
DELETE	删除资源	http://xx.com/api/orders/1

REST framework扩展了常规的Request,提供了一个更加灵活的HttpRequest方法。其中Request的核心是request.data属性，这个属性类似于request.POST，但是在web apis当中显得更加的灵活

request.POST #仅适用于表单的提交时的操作
request.data #可以适用于做任意的数据，比较'POST','PUT'和'PATCH'方法

###响应对象 rest framework引入了一个Response 对象，它继承自TemplateResponse对象。它获得未渲染的内容并通过内容协商content negotiation 来决定正确的content type返回给client。

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

状态码

rest framework为每个状态码提供了更明确的标记。例如 HTTP_404_NOT_FOUND、HTTP_200_OK、HTTP_201_CREATED 更多.相对于单调的数据而言这类标识符显得更加的直观。

封装API views

在编写api view时，rest framework提供了两个wrappers

The @api_view decorator for working with function based views.
The APIView class for working with class based views.

这两种封装器提供了许多功能，例如，确保在view当中能够接收到Request实例；往Response中增加内容以便内容协商content negotiation 机制能够执行。

汇总

现在我们开始用新的组件编写views 我们不需要再使用JSONResponse类，删除之前在views.py中那部分代码。t我们重新开始重构新的代码.

@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 seralizer.is_valid():
            serializer.save()
            return Response(seralizer.data,status=status.HTTP_201_CREATED)
        return Response(seralizer.errors,status=status.HTTP_400_BAD_REQUEST)

上面的代码是对我们之前代码的改进。看上去更简洁，也更类似于django的forms api形式。我们也采用了状态码，使返回值更加明确。下面是对单个snippet操作的view更新：

@api_view(['GET', 'PUT', 'DELETE'])
def snippet_detail(request, pk):
    """
    Retrieve, update or delete a snippet instance.
    """
    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)

上面的代码中可以发现，我们并没有明确的指定request和response的内容类似。request.DATA不仅可以处理json的请求，也可以输入其他的格式.REST Framework会自动响应正确的内容呈现给client ![屏幕快照 2016-04-12 下午10.38.31](http://7xrkms.com1.z0.glb.clouddn.com/2016-04-12-屏幕快照 2016-04-12 下午10.38.31.png)

###给URLs增加可选的格式后缀我们在api添加一个后缀明确指定该url的格式，比如http://example.com/api/items/4.json.的URL. 表示是按json的方法进行处理。现在我们修改之前的urls.py，只要在后面添加一个format_suffix_patterns(urlpatterns)

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)