178

私はDjangoRESTフレームワークの初心者であり、アドバイスが必要です。私はWebサービスを開発しています。このサービスは、他のサービスへのRESTインターフェースを提供する必要があります。実装する必要のあるRESTインターフェースは、モデルを直接操作していません（つまり、get、put、post、delete操作を意味します）。代わりに、他のサービスにいくつかの計算結果を提供します。リクエストに応じて、私のサービスはいくつかの計算を行い、結果を返します（結果を独自のデータベースに保存しません）。

以下は、そのRESTインターフェースを実装する方法についての私の理解です。私が間違っているなら、私を訂正してください。

  1. 計算を行うクラスを作成します。「CalcClass」という名前を付けます。CalcClassは、その作業でモデルを使用します。
    • 計算に必要なパラメーターはコンストラクターに渡されます。
    • 計算操作を実装します。結果を「ResultClass」として返します。
  2. ResultClassを作成します。
    • オブジェクトから派生。
    • 計算結果を含む属性のみがあります。
    • 計算結果の一部は、タプルのタプルとして表されます。私が理解しているように、これらの結果に対して別のクラスを実装し、そのようなオブジェクトのリストをResultClassに追加することで、さらにシリアル化する方がよいでしょう。
  3. ResultClassのシリアライザーを作成します。
    • serializers.Serializerから派生します。
    • 計算結果は読み取り専用であるため、IntegerFieldなどの特殊なクラスではなく、ほとんどの場合、フィールドにFieldクラスを使用します。
    • 結果を保存するつもりはないので、ResultClassにもSerializerにもsave（）メソッドを実装しないでください（要求に応じてそれらを返したいだけです）。
    • ネストされた結果のImplシリアライザー（上記のタプルのタプルを思い出してください）。
  4. ビューを作成して計算結果を返します。
    • APIViewから派生します。
    • get（）が必要です。
    • get（）で、リクエストから取得したパラメータを使用してCalcClassを作成し、そのcalc（）を呼び出し、ResultClassを取得し、Serializerを作成して、それにResultClassを渡し、Response（serializer.data）を返します。
  5. URL
    • 私の場合、APIルートはありません。さまざまな計算結果（diffパラメータを使用した計算）を取得するためのURLが必要です。
    • APIブラウジング用の呼び出しformat_suffix_patternsを追加します。

私は何か見落としてますか？アプローチは一般的に正しいですか？

4

1 に答える 1

174

Django-rest-frameworkは、モデルに関連付けなくてもうまく機能します。あなたのアプローチは問題ないように聞こえますが、すべてを機能させるためにいくつかのステップをトリミングできると思います。

たとえば、RESTフレームワークにはいくつかの組み込みレンダラーが付属しています。箱から出して、JSONとXMLをAPIコンシューマーに返すことができます。必要なPythonモジュールをインストールするだけでYAMLを有効にすることもできます。Django-rest-frameworkは、dict、list、tupleなどの基本的なオブジェクトを、余分な作業なしで出力します。

したがって、基本的には、引数を取り、必要なすべての計算を実行し、その結果をタプルでRESTAPIビューに返す関数またはクラスを作成するだけで済みます。JSONやXMLがニーズに合っている場合は、django-rest-frameworkがシリアル化を処理します。

この場合、手順2と3をスキップして、1つのクラスを計算に使用し、もう1つを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にアクセスすると、リストのリストを出力する必要があります。接尾辞を使用する場合は、で置き換えることができ?format=jsonます.json。ヘッダーに"Content-type"またはを追加して、取得するエンコーディングを指定することもできます。"Accept"

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

これがお役に立てば幸いです。

于 2012-11-29T11:05:25.417 に答える