web-dev-qa-db-ja.com

REST API for Djangoアプリケーションの作成

Djangoテクノロジーを使用してアプリケーションAPI（REST）を作成する必要があります。複数のモデルからエントリを読み取り（GET）し、それらを結合し、 JSON形式（1つまたは複数のオブジェクト）を使用してそれらを返しますjsonスキーマと適切なjsonファイルの例はすでに提供されています。

APIを作成するのはこれが初めてであり、Djangoにはあまり馴染みがないので、ご案内をお願いします。

最も人気があると思われる2つのフレームワークを検索しました。

これまで見てきたように、これら2つを使用すると、アプリケーションのAPIをすばやくセットアップできます。しかし、それらの1つを使用してカスタムJSON形式を作成できますか、これを行う別の方法がありますか？

pythondjangorest
28
TheAptKid

Tastypieの使用：-

models.py

class User(Document):
    name = StringField()

api.py

from tastypie import authorization
from tastypie_mongoengine import resources
from project.models import *
from tastypie.resources import *

class UserResource(resources.MongoEngineResource):
class Meta:
    queryset = User.objects.all()
    resource_name = 'user'
    allowed_methods = ('get', 'post', 'put', 'delete','patch')
    authorization = authorization.Authorization()

url.py

from tastypie.api import Api
from projectname.api import *

v1_api = Api(api_name='v1')
v1_api.register(UserResource())

Javascript（jQuery）

この例はGETリクエストのものです。

$(document).ready(function(){
    $.ajax({
       url: 'http://127.0.0.1:8000/api/v1/user/?format=json',
       type: 'GET',                   
       contentType: 'application/json',
       dataType: 'json',
       processData: false,
       success: function(data){
           alert(data)
       //here you will get the data from server
       },
       error: function(jqXHR, textStatus, errorThrown){
              alert("Some Error")                                  
       }
    })
})

POSTリクエストの場合、タイプをPOSTに変更し、dataを適切な形式で送信します

詳細については、 Tastypie docs を参照してください

18
Nullify

私はDjango REST=フレームワークを使用し、一般的にはどのように動作するのかを確認しました。

理論的には、表現形式を強制するものではありません。公開するフィールドとコンテンツ、およびシリアル形式を指定する「シリアライザ」を定義します。それでも、一部の形式は他の形式よりも簡単です。最終的に、必要なJSONオブジェクトを返す単純な関数ベースのビューを追加できます。その場合でも、フレームワークは完全なAPIを取得するために必要な作業量を大幅に削減します。

Djangoの場合のように、最良の方法は、チュートリアル全体を少なくとも1回実行して、どこに行くのかを把握することです。それをしている間、あなたの特定の問題に合わせて例を修正する誘惑に屈しないでください。それは物事をより複雑にするだけです。チュートリアル全体を終えた後、「簡単な」形式がニーズにどれだけ近いかを自分で確認できます。

12
Javier

Django REST Frameworkを使用して

Django 1.8.4およびDRF 3.3.3。

以下はDjango=REST Frameworkとjsonschemaパッケージ（pip install jsonschema）。

カスタムフィールドは、DRFの既存のJSONFieldクラスからいくつかの小さな変更を継承します。 JSONSchema定義に対して着信JSONを検証するステップを追加します。検証に合格すると、Django model TextFieldを使用して生のJSON文字列を保存/取得します。

in app/serializers.py

import json
from rest_framework import serializers
from jsonschema import validate  # validates incoming data against JSONSchema
from jsonschema.exceptions import ValidationError as JSONSchemaValidationError
from .models import Lesson

from .jsonschema import (
    notes_schema,
)


class JSONSchemaField(serializers.JSONField):
# Custom field that validates incoming data against JSONSchema, 
# Then, if successful, will store it as a string.

    def __init__(self, schema, *args, **kwargs):
        super(JSONSchemaField, self).__init__(*args, **kwargs)
        self.schema = schema

    def to_representation(self, obj):
        return json.loads(obj)

    def to_internal_value(self, data):
        try:
            validate(data, self.schema)
        except JSONSchemaValidationError as e:
            raise serializers.ValidationError(e.message)

        return super(JSONSchemaField, self).to_internal_value(json.dumps(data))


class LessonSerializer(serializers.HyperlinkedModelSerializer):
    notes = JSONSchemaField(notes_schema)

    class Meta:
        model = Lesson
        fields = ('url', 'title', 'bpm', 'notes')

in app/models.py

from Django.db import models


class Lesson(models.Model):
    created = models.DateTimeField(auto_now_add=True)
    title = models.CharField(max_length=100, blank=True, default='Untitled')
    bpm = models.DecimalField(max_digits=5, decimal_places=2, default=120.00)
    notes = models.TextField()

    class Meta:
        ordering = ('created',)

in app/jsonschema.py

notes_schema = {
    "type": "array",
    "items": {
        "type": "object",
        "properties": {
            "name": {
                "type": "string",
                "pattern": "^[A-G][#b]?[0-9]$"
            },
            "duration": {
                "type": "string",
                "pattern": "^\d+\/\d+$"
            }
        },
        "required": ["name", "duration"]
    }
}

notes_example = [{"name": "C#4", "duration": "1/4"},
                 {"name": "A4", "duration": "1/32"}]

In app/views.py

from rest_framework import viewsets

from .models import Lesson
from .serializers import LessonSerializer


class LessonViewSet(viewsets.ModelViewSet):
    queryset = Lesson.objects.all()
    serializer_class = LessonSerializer
5
jfunk

もう1つの良い組み合わせは、Django-Restless、 https://Django-restless.readthedocs.org/en/latest/ で、モデル内に独自のシリアライザーを作成するだけです。例えば

## Models
class Blog(models.Model):
    title = models.CharField()
    user = models.ForeignKey(settings.AUTH_USER_MODEL)
    text = models.TextField()

    def __init__(self, *args, **kwargs):
        self.super().__init__(*args, **kwargs)
        self.schema = { 
            "title" : self.title,
            "text"  : self.text,
            "user"  : self.user.full_name
        }

    @property
    def list_view(self):
        fields = ["title","user"]
        return {key: self.schema[key] for key in fields}

    @property
    def detail_view(self):
        fields = ["title","text","user"]
        return {key: self.schema[key] for key in fields}

## views
from restless.views import Endpoint
from .models import *
class BlogList(Endpoint):
    def get(self, request):
        posts = [blog.list_view for blog in Blog.objects.all()]
        return json.dumps({posts})

また、他のHTTP動詞をメソッドとして追加し、このデータを検証するためのフォームを使用できます。

4
user1876508

サーバー側で Django-piston を使用してRESTの呼び出しを処理します。

[クライアント]←REST→[Webサーバー] — [Django/ Django-piston ]

また、応答は ここも同様 で確認できます。

0
Ming Chan