json序列化 - django rest framework教程



Django REST框架:非模型序列化器 (1)

我是Django REST框架的初学者,需要您的建议。 我正在开发一个Web服务。 该服务必须为其他服务提供REST接口。 REST接口,我需要实现,不直接与我的模型(我的意思是获取,放置,发布,删除操作)。 相反,它提供了一些计算结果的其他服务。 在请求中,我的服务进行了一些计算,只是返回结果(不将结果存储在它自己的数据库中)。

以下是我对REST接口如何实现的理解。 纠正我,如果我错了。

  1. 创建进行计算的类。 将其命名为'CalcClass'。 CalcClass在其工作中使用这些模型。
    • 计算所需的参数传递给构造函数。
    • 实施计算操作。 它将结果作为“ResultClass”返回。
  2. 创建ResultClass。
    • 从对象派生。
    • 它只是具有包含计算结果的属性。
    • 计算结果的一部分表示为元组的元组。 据我所知,对于进一步的序列化来说,为这些结果实现一个单独的类并将这些对象的列表添加到ResultClass会更好。
  3. 为ResultClass创建序列化程序。
    • 从serializers.Serializer派生。
    • 计算结果是只读的,所以大多使用Field类作为字段,而不是专用类,例如IntegerField。
    • 我不应该在ResultClass和Serializer上impl save()方法,因为我不打算存储结果(我只是想根据请求返回它们)。
    • 用于嵌套结果的Impl序列化器(记得上面提到的元组的元组)。
  4. 创建视图以返回计算结果。
    • 从APIView派生。
    • 只需要()。
    • 在get()中,用从请求中获取的参数创建CalcClass,调用它的calc(),获得ResultClass,创建Serializer并将ResultClass传递给它,返回Response(serializer.data)。
  5. 网址
    • 我的情况没有api根。 我应该只有URL来获得各种计算结果(用差异参数进行计算)。
    • 为api浏览添加调用format_suffix_patterns。

我错过了什么? 一般来说这种方法是正确的吗?


Django-rest-framework即使不绑定到模型也可以很好地工作。 你的方法听起来不错,但我相信你可以修改一些步骤来让所有的工作都能正常工作。

例如,rest框架附带一些内置的渲染器。 开箱即可以将JSON和XML返回给API使用者。 您也可以通过安装所需的python模块来启用YAML。 Django-rest-framework将输出任何像dict,list和tuple这样的基本对象,而不需要额外的工作。

所以基本上你只需要创建接受参数的函数或类,完成所有需要的计算并将其结果返回到REST API视图。 如果JSON和/或XML符合您的需求,django-rest-framework将为您处理序列化。

在这种情况下,您可以跳过步骤2和步骤3,只需使用一个类进行计算,然后使用一个类向API消费者演示。

这里有几个片段可以帮助你:

请注意,我没有测试过这个。 这只是作为一个例子,但它应该工作:)

CalcClass:

class CalcClass(object):

    def __init__(self, *args, **kw):
        # Initialize any variables you need from the input you get
        pass

    def do_work(self):
        # Do some calculations here
        # returns a tuple ((1,2,3, ), (4,5,6,))
        result = ((1,2,3, ), (4,5,6,)) # final result
        return result

REST视图:

from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework import status

from MyProject.MyApp import CalcClass


class MyRESTView(APIView):

    def get(self, request, *args, **kw):
        # Process any get params that you may need
        # If you don't need to process get params,
        # you can skip this part
        get_arg1 = request.GET.get('arg1', None)
        get_arg2 = request.GET.get('arg2', None)

        # Any URL parameters get passed in **kw
        myClass = CalcClass(get_arg1, get_arg2, *args, **kw)
        result = myClass.do_work()
        response = Response(result, status=status.HTTP_200_OK)
        return response

你的urls.py:

from MyProject.MyApp.views import MyRESTView
from django.conf.urls.defaults import *

urlpatterns = patterns('',
    # this URL passes resource_id in **kw to MyRESTView
    url(r'^api/v1.0/resource/(?P<resource_id>\d+)[/]?$', login_required(MyRESTView.as_view()), name='my_rest_view'),
    url(r'^api/v1.0/resource[/]?$', login_required(MyRESTView.as_view()), name='my_rest_view'),
)

此代码应在您访问http://example.com/api/v1.0/resource/?format=json时输出列表。 如果使用后缀,则可以用.json替换?format=json 。 您也可以通过在标题中添加"Content-type""Accept"来指定您希望获得的编码。

[
  [
    1, 
    2, 
    3
  ], 
  [
    4, 
    5, 
    6
  ]
]

希望这可以帮助你。





django-rest-framework