Django बाकी ढांचे का उपयोग कर वेब एपीआई

वेब सेवा (Eng। वेब सेवा) - मानकीकृत इंटरफेस के साथ वेब एड्रेस सॉफ्टवेयर सिस्टम द्वारा पहचानी जाती है। कुछ प्रोटोकॉल (XML, JSON, आदि) पर आधारित संदेशों के माध्यम से वेब सेवाएं एक-दूसरे के साथ और तृतीय-पक्ष अनुप्रयोगों के साथ संवाद कर सकती हैं। एक वेब सेवा सेवा-उन्मुख अनुप्रयोग वास्तुकला का उपयोग करते समय मॉड्यूलरिटी की एक इकाई है।

वेब सेवा बनाने का एक तरीका बाकी है।
आराम करो । REST डेटा को कम संख्या में मानक प्रारूपों (जैसे HTML, XML, JSON) में प्रेषित किया जाना चाहिए। नेटवर्क प्रोटोकॉल (जैसे HTTP) को कैशिंग का समर्थन करना चाहिए, नेटवर्क परत पर निर्भर नहीं होना चाहिए, और अनुरोध-प्रतिक्रिया जोड़े के बीच राज्य की जानकारी संग्रहीत नहीं करनी चाहिए। यह तर्क दिया जाता है कि यह दृष्टिकोण प्रणाली को स्केलेबिलिटी प्रदान करता है और इसे नई आवश्यकताओं के साथ विकसित करने की अनुमति देता है।


Django REST फ्रेमवर्क, Django ढांचे की विचारधारा के आधार पर आराम के साथ काम करने के लिए एक सुविधाजनक उपकरण है।

पर्यावरणीय आवश्यकताएँ:
अजगर (२.६, २.th)
Django (1.3, 1.4, 1.5)

अनुरोध पर:
Markdown
PyYAML
Django फिल्टर

स्थापना

आप हमारे लिए सामान्य पाइप कमांड स्थापित कर सकते हैं:

pip install djangorestframework 

और आप अतिरिक्त पैकेज डाल सकते हैं:

 pip install markdown pip install pyyaml pip install django-filter 

या जीथब के साथ परियोजना का एक क्लोन बनाएं:

 git clone git@github.com:tomchristie/django-rest-framework.git cd django-rest-framework pip install -r requirements.txt pip install -r optionals.txt 

INSTALLED_APPS में आवेदन दर्ज करना न भूलें:

 INSTALLED_APPS = ( ... 'rest_framework', ) 

और urls.py में प्रविष्टि भी जोड़ें:

 urlpatterns = patterns('', ... url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework')) ) 

Url को आपकी पसंद के हिसाब से सेट किया जा सकता है, मुख्य बात यह है कि किसी फ़ाइल को urls बाकी ढांचे (rest_framework.bls) से जोड़ा जाए।

उदाहरण का उपयोग करें

उपयोगकर्ताओं और उनके समूहों के साथ काम करने के लिए एक एपीआई बनाएं।

सबसे पहले, हमें कुछ Serializers परिभाषित करने की आवश्यकता है जो हम उपयोग करेंगे।

 from django.contrib.auth.models import User, Group, Permission from rest_framework import serializers class UserSerializer(serializers.HyperlinkedModelSerializer): class Meta: model = User fields = ('url', 'username', 'email', 'groups') class GroupSerializer(serializers.HyperlinkedModelSerializer): permissions = serializers.ManySlugRelatedField( slug_field='codename', queryset=Permission.objects.all() ) class Meta: model = Group fields = ('url', 'name', 'permissions') 

आइए विचार लिखते हैं

 from django.contrib.auth.models import User, Group from rest_framework import generics from rest_framework.decorators import api_view from rest_framework.reverse import reverse from rest_framework.response import Response from quickstart.serializers import UserSerializer, GroupSerializer @api_view(['GET']) def api_root(request, format=None): """ The entry endpoint of our API. """ return Response({ 'users': reverse('user-list', request=request), 'groups': reverse('group-list', request=request), }) class UserList(generics.ListCreateAPIView): """ API endpoint that represents a list of users. """ model = User serializer_class = UserSerializer class UserDetail(generics.RetrieveUpdateDestroyAPIView): """ API endpoint that represents a single user. """ model = User serializer_class = UserSerializer class GroupList(generics.ListCreateAPIView): """ API endpoint that represents a list of groups. """ model = Group serializer_class = GroupSerializer class GroupDetail(generics.RetrieveUpdateDestroyAPIView): """ API endpoint that represents a single group. """ model = Group serializer_class = GroupSerializer 

हमने api_root फ़ंक्शन बनाया, जो हमारे API के लिए शुरुआती बिंदु होगा। और चार वर्गों, मॉडल के साथ संवाद करने के लिए, संकेत दिया कि किस धारावाहिक का उपयोग किया जाना चाहिए।

Urls.py पर लिंक जोड़ें

 from django.conf.urls import patterns, url, include from rest_framework.urlpatterns import format_suffix_patterns from quickstart.views import UserList, UserDetail, GroupList, GroupDetail urlpatterns = patterns('quickstart.views', url(r'^$', 'api_root'), url(r'^users/$', UserList.as_view(), name='user-list'), url(r'^users/(?P<pk>\d+)/$', UserDetail.as_view(), name='user-detail'), url(r'^groups/$', GroupList.as_view(), name='group-list'), url(r'^groups/(?P<pk>\d+)/$', GroupDetail.as_view(), name='group-detail'), ) # Format suffixes urlpatterns = format_suffix_patterns(urlpatterns, allowed=['json', 'api']) # Default login/logout views urlpatterns += patterns('', url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework')) ) 

एक महत्वपूर्ण बिंदु उपयोगकर्ता-विवरण और समूह-विवरण का उपयोग है। विचारों के साथ सही संचार के लिए आपको प्रपत्र {मॉडलनाम} -डेट का नामकरण का उपयोग करना होगा।
Format_suffix_patterns में हमने अपने यूआरएल के लिए एक प्रत्यय निर्दिष्ट किया है।

सेटिंग

 INSTALLED_APPS = ( ... 'rest_framework', ) REST_FRAMEWORK = { 'DEFAULT_PERMISSION_CLASSES': ('rest_framework.permissions.IsAdminUser',), 'PAGINATE_BY': 10 } 

परिणाम

कंसोल में कर्ल का उपयोग करके हम परीक्षण करेंगे कि क्या हुआ:

 bash: curl -H 'Accept: application/json; indent=4' -u admin:password http://127.0.0.1:8000/users/ { "count": 2, "next": null, "previous": null, "results": [ { "email": "admin@example.com", "groups": [], "url": "http://127.0.0.1:8000/users/1/", "username": "admin" }, { "email": "tom@example.com", "groups": [ ], "url": "http://127.0.0.1:8000/users/2/", "username": "tom" } ] } 

ब्राउज़र में आप कुछ इस तरह देख सकते हैं:


संदर्भ:
परियोजना स्थल
Github

PS django में आराम के साथ काम करने के लिए, एक और बुरा अनुप्रयोग नहीं है जिसे django-piston कहा जाता है। यदि आप चाहें, तो आप इसके बारे में लिख सकते हैं, हालांकि उपयोग में यह काफी जटिल नहीं है।