كيف تنشئ واجهات برمجة التطبيقات REST باستخدام إطار عمل Django REST؟

في عالم توثيق واجهات برمجة التطبيقات (API) والتكامل المتطور دائمًا اليوم، يُعتبر Apidog أداة متعددة الاستخدامات تعمل مع عدة أطر عمل API فريدة مثل REST (نقل حالة تمثيلية). تسهل هذه الأداة على المستخدم تبسيط عملية التطوير.

ستتناول هذه المقالة دور Apidog في تنسيق التكامل السلس مع إطار العمل REST الخاص بـ Django. كما سيتم توجيهك من خلال دليل شامل لاستخدام Apidog للاستفادة القصوى من إطار العمل Django REST الخاص بك.

زر

ما هو Django؟

Django هو إطار عمل ويب بلغة Python على مستوى عالٍ يشجع على التطوير السريع والتصميم النظيف. يتبع نمط العمارة نمط النموذج-عرض-تحكم (MVC) ويعرف بسهولته ومرونته وقابليته للتوسع. يوفر Django مجموعة قوية من الأدوات والمكتبات لبناء تطبيقات الويب.

يتبع مبدأ "لا تكرر نفسك" (DRY) ويشدد على أهمية كتابة كود قابل لإعادة الاستخدام. يهدف إلى تبسيط عملية التطوير من خلال تقديم مكونات مسبقة البناء ومواثيق، مما يسمح للمطورين بالتركيز على بناء الميزات بدلاً من التعامل مع الكود النمطي.

ما هو REST API؟

REST هو أسلوب معماري لتصميم تطبيقات الشبكة. واجهات برمجة التطبيقات التي تعتمد على REST تلتزم بمبادئ REST، مع التأكيد على نموذج الاتصال بدون حالة بين العميل والخادم. تستخدم واجهات برمجة التطبيقات REST طرق HTTP القياسية (GET، POST، PUT، DELETE) للعمليات على الموارد، وغالباً ما تتواصل باستخدام JSON أو XML للتبادل البياني.

REST لا يحافظ على الحالة، مما يعني أن كل طلب من العميل يحتوي على كل المعلومات اللازمة لفهم ومعالجة الطلب. توفر واجهته الموحدة طريقة متسقة للتفاعل مع الموارد.

ما هو إطار عمل Django REST؟

إطار عمل Django REST (DRF) هو مجموعة أدوات قوية ومرنة لبناء واجهات برمجة التطبيقات الويب في تطبيقات Django. يوفر Django، كإطار عمل ويب Python عالي المستوى، أساسًا قويًا لبناء تطبيقات الويب.

ومع ذلك، لا يتضمن أدوات محددة لبناء واجهات برمجة التطبيقات. هنا يأتي دور إطار عمل Django REST. يمتد DRF على Django لجعل من السهل بناء واستهلاك واجهات برمجة التطبيقات RESTful. يوفر أدوات، ومحولين، وواجهات تساعد المطورين على إنشاء واجهات برمجة التطبيقات بسرعة والتعامل مع المهام الشائعة مثل المصادقة، والأذونات، والتسلسل.

لماذا تستخدم Django؟

يعتبر استخدام Django مفيدًا للأسباب التالية:

توثيق ممتاز ودعم من المجتمع:

يمتاز Django بتوثيق شامل يغطي كل من الإطار الأساسي والحزم ذات الصلة.
يمتلك Django مجتمعًا كبيرًا ونشطًا، مع العديد من الشركات المعترف بها دوليًا تستخدمه، مثل Mozilla وRed Hat وHeroku وEventbrite.

إطار عمل ويب قوي ومرن:

يوفر Django واجهة برمجة تطبيقات قابلة للتصفح عبر الويب، مما يحسن من قابلية الاستخدام والإنتاجية للمطورين.
Django قابل للتخصيص، مما يسمح باستخدام الواجهات التي تعتمد على الدوال العادية إذا لم تكن الميزات المتقدمة مطلوبة.

مصادقة وأمان قويين: (مع إطار عمل Django REST):

يتضمن إطار عمل Django REST سياسات حقيقية للمصادقة وحزم لـ OAuth1a وOAuth2.

تسلسل متعدد الاستخدامات: (مع إطار عمل Django REST):

يدعم إطار عمل Django REST التسلسل لكل من موارد ORM (تعيين كائنات العلاقة) وغير موارد ORM.

من خلال استخدام Django، يمكن للمطورين الاستفادة من إطار عمل ويب موثق جيدًا وشائع الاستخدام مع ميزات قوية وخيارات تخصيص مرنة، بالإضافة إلى مجتمع قوي. بالإضافة إلى ذلك، عند دمجه مع إطار عمل Django REST، يوفر آليات مصادقة وأمان قوية، بالإضافة إلى قدرات تسلسل بيانات متعددة الاستخدامات.

كيف تنشئ واجهة برمجة تطبيقات REST باستخدام إطار عمل Django؟

لإنشاء واجهات برمجة تطبيقات REST باستخدام Django، تحتاج إلى إطار عمل Django REST، الذي سيسهل عليك عملية بناء واجهات برمجة التطبيقات بالكامل.

يجب عليك إعداد إطار عمل Django REST. تأكد من تثبيت Python في النظام مسبقًا. يُوصى باستخدام Python 3 لأنه يوفر دعمًا أفضل وميزات أكثر. إذا لم يتم تثبيته، يمكنك تثبيته هنا.

الخطوة 1. تثبيت Django وإطار عمل Django REST

استخدم الأمر أدناه في نافذة الأوامر أو PowerShell لتثبيت Django وإطار عمل Django REST.

pip install django djangorestframework

الخطوة 2. إنشاء مشروع Django

بعد ذلك، تحتاج إلى إنشاء دليل Django الخاص بك لوضع جميع ملفات مشروعك.

mkdir projectname

ثم تحتاج إلى البدء في بناء مشروعك من خلال كتابة الأوامر التالية.

django-admin startproject projectname

الخطوة 3. الانتقال إلى دليل المشروع

اذهب داخل دليل المشروع الذي أنشأته للتو باستخدام projectname.

cd projectname

الخطوة 4. إنشاء تطبيق Django

الآن، قم بإنشاء تطبيق Django للبدء في العمل على تطبيقك.

python manage.py startapp appname

الخطوة 5. تعريف النماذج الخاصة بك

في تطبيقك، حدد نماذج تمثل البيانات التي تريد عرضها من خلال API في models.py. على سبيل المثال:

from django.db import models

class Item(models.Model):

name = models.CharField(max_length=100)

description = models.TextField()

الخطوة 6. إنشاء الترحيلات الخاصة بك

قم بتشغيل الترحيلات لإنشاء جداول قاعدة البيانات.

python manage.py makemigrations

python manage.py migrate

الخطوة 7. إنشاء المخصصات

تحويل المخصصات تحول مثيلات النماذج إلى أنواع بيانات Python. أنشئ مخصصًا في تطبيقك، مثلاً، serializers.py.

from rest_framework import serializers

from .models import Item

class ItemSerializer(serializers.ModelSerializer):

class Meta:

model = Item

fields = '__all__'

الخطوة 8. إنشاء وجهات نظر باستخدام ViewSets

استخدم ViewSets الخاصة بـ DRF لتعريف وجهات نظر API. أنشئ ملفًا، مثلاً، views.py.

from rest_framework import viewsets

from .models import Item

from .serializers import ItemSerializer

class ItemViewSet(viewsets.ModelViewSet):

queryset = Item.objects.all()

serializer_class = ItemSerializer

الخطوة 9. تكوين URLs

قم بتكوين URLs لتتوافق مع وجهات نظرك. في urls.py الخاصة بتطبيقك، قم بالإدخال.

from rest_framework import routers

from .views import ItemViewSet

router = routers.DefaultRouter()

router.register(r'items', ItemViewSet)

urlpatterns = router.urls

وقم بإدراج هذه URLs في urls.py الخاصة بمشروعك.

from django.contrib import admin

from django.urls import path, include

urlpatterns = [

path('admin/', admin.site.urls),

path('api/', include('appname.urls')),

]

الخطوة 10. تشغيل خادم التطوير

يمكنك الآن بدء تشغيل خادم التطوير.

from django.contrib import admin

from django.urls import path, include

urlpatterns = [

path('admin/', admin.site.urls),

path('api/', include('appname.urls')),

]

ستكون واجهة برمجة التطبيقات المحلية الخاصة بك متاحة لك بعد نجاح إنشاء مشروعك.

ستبدو واجهة برمجة التطبيقات الخاصة بك كالتالي: “http://localhost:8000/api/items/”. ستختلف URL الخاصة بك بناءً على تكويناتك. يمكنك استخدام هذه URL في Apidog لاختبار ووثائق ومحاكاة وإدارة واجهة برمجة التطبيقات الخاصة بك.

يجب أن تبدو دليل مشروعك كالتالي بعد إنشاء الملفات المعنية.

ما هو Apidog؟

Apidog هو منصة تكامل واجهات برمجة التطبيقات التي تبسط وت优化 اختبار واجهات برمجة التطبيقات، وتصحيح الأخطاء، والتصميم، والمحاكاة، والتوثيق.

الميزات الرئيسية لـ Apidog:

يسهل اختبار واجهات برمجة التطبيقات بشكل شامل ويسمح بإنشاء مخططات JSON/XML لنتائج/استجابات الاختبار
قدرات توثيق API ممتازة مع تخطيطات قابلة للتخصيص
أدوات مرئية لاختبار واجهات برمجة التطبيقات، مثل إضافة افتراضات وإنشاء سيناريوهات اختبار

تمكن من مشاركة والتعاون في مشاريع واجهات برمجة التطبيقات مع أعضاء الفريق

دمج Apidog مع إطار عمل Django REST

الآن بعد أن أنشأت واجهة برمجة التطبيقات باستخدام إطار عمل Django REST، سننظر في كيفية اختبار وإدارة واجهة برمجة التطبيقات الخاصة بك باستخدام Apidog. يساعدك Apidog في اختبار وتوثيق ومحاكاة واجهات برمجة التطبيقات الخاصة بك.

يمكنك البدء بفتح الموقع الرسمي لـ Apidog، https://apidog.com/. يمكنك التسجيل مجانًا أو تنزيل النسخة المتوافقة مع نظامك لبدء استخدام خدمات Apidog.

زر

يمكنك إنشاء مشروع جديد عن طريق النقر على زر "مشروع جديد" على الجانب الأيمن. احتفظ باسم مناسب لمشروعك واختر نوع المشروع.

بينما نعمل مع واجهة برمجة تطبيقات REST، سنختار طريقة HTTP لاستخدام طرق POST وGET وPUT.

يمكنك إنشاء واجهة برمجة تطبيقات جديدة وتطبيق طرق مختلفة على طلبك. سننظر في طريقة GET لمضيفنا المحلي. في حالتنا، نفترض أن URL لدينا هو “http://localhost:8000/api/items/”.

سيتوجب عليك استخدام URL المحلي الذي تحصل عليه من تطبيق Django الخاص بك. سنقوم بإدخال هذه URL في حقل الإدخال لدينا وإرسال الطلب.

سوف تحصل على استجابة لطلبك، ويمكنك التحقق من مخرجات طلبك هناك. يمكنك رؤية مخرجاتك في الاستجابة إذا لم يكن لديك أي خطأ في التحقق.

وإلا، فسترى خطأ يفيد أن طلبك فشل في الإرسال. في هذه الحالة، يجب عليك التأكد من أنك قمت بتنفيذ جميع الخطوات اللازمة لإنشاء API بشكل صحيح.

كما ترى أعلاه، طلبٌ أصدر استجابة صالحة. يمكنك التحقق من طرق HTTP الأخرى مثل PUT وPOST وDELETE، إلخ. يمكنك أيضًا اختبار واجهة برمجة التطبيقات الخاصة بك في قسم الاختبار. سيعطيك خيارات متعددة مثل إنشاء تقارير اختبار، وبيانات اختبار، وCI/CD (التكامل المستمر/التسليم المستمر).

الآن بعد أن أصبحت على دراية بـ Apidog، يمكنك استكشاف المزيد من الميزات من خلال اللعب بالتطبيق. يمكنك أيضًا تعديل الإعدادات لتناسب تكويناتك المطلوبة.

أفضل الممارسات مع Apidog وDRF

إصدار:

فكر في إصدار واجهات برمجة التطبيقات الخاصة بك في كل من Apidog وDRF. يجب أن تحدد بوضوح إصدارات API في التوثيق لإدارة التغييرات وضمان التوافق.

استخدم المخصصات بفعالية:

استفد من مخصصات DRF للتعامل مع تسلسل البيانات وفك تسلسلها. حافظ على مخصصاتك سليمة و_USEها بثبات عبر العروض.

العروض المعتمدة على الفئات وViewSets:

نظم منطق واجهات برمجة التطبيقات الخاصة بك باستخدام العروض المعتمدة على الفئات وViewSets في DRF وحافظ على قاعدة شيفرة نظيفة ومنظمة.

الاختبار:

اكتب اختبارات شاملة لواجهات برمجة التطبيقات الخاصة بك ومنطقها في DRF. تأكد من أن Apidog تعكس أي تغييرات على API وتظل متوافقة مع السلوك الفعلي.

المصادقة والأذونات:

قم بتنفيذ آليات المصادقة والتفويض المقدمة من DRF. وثّق بوضوح متطلبات المصادقة في Apidog ليشملها المطورون كمراجع.

الخاتمة

في الختام، يقدم دمج Apidog وإطار عمل Django REST (DRF) منصة قوية للمطورين للانخراط في توثيق ودمج واجهات برمجة التطبيقات (API). يسمح Apidog، بفضل ميزاته المتعددة، بإنشاء توثيق شامل وواضح لواجهات برمجة التطبيقات.

توفر الأمثلة التفاعلية، والتحرير التعاوني، وقدرات الإصدار بيئة سهلة الاستخدام للمطورين لفهم واختبار ودمج واجهات برمجة التطبيقات بسلاسة.

يساعد DRF في بناء واجهات برمجة التطبيقات RESTful ويكمل Apidog بتوفير حل خلفي منظم وفعال. من خلال الاستفادة من مخصصات DRF، والعروض المعتمدة على الفئات، وآليات المصادقة، يمكن للمطورين إنشاء واجهات برمجة التطبيقات التي تلتزم بأفضل ممارسات البرمجة. تشجع مجموعة أدوات هذه على نهج شامل لتطوير واجهات برمجة التطبيقات.

زر