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

يعد إنشاء واجهة برمجة تطبيقات REST طريقة ملائمة لمشاركة المعلومات. حددت واجهات برمجة تطبيقات REST معايير تنظم مشاركة البيانات بين الأجهزة. لفهم كيفية عمل REST APIs ، يمكنك إنشاء واحدة من البداية.

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

باستخدام Django مع واجهة برمجة تطبيقات REST

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

يجب أيضًا تثبيت ما يلي مسبقًا:

  1. أحدث نسخة من بيثون.
  2. أحدث نسخة من النقطة.
  3. Pipenv (على الرغم من أنه يمكنك استخدام venv بدلاً من ذلك إذا كنت تريد ذلك).
  4. أحدث نسخة من Django.

بمجرد تثبيت جميع البرامج الأساسية ، تكون جاهزًا للبدء.

1. قم بتثبيت Django REST Framework

إطار عمل Django REST هي مجموعة أدوات قوية يمكنك استخدامها لبناء وتهيئة واجهات برمجة تطبيقات الويب. ميزاته القابلة للتخصيص تجعله خيارًا شائعًا لبناء واجهات برمجة تطبيقات REST.

instagram viewer

يمكنك تثبيت إطار عمل Django REST بالأمر التالي:

بيبينف ثَبَّتَ djangorestframework

2. قم بإنشاء تطبيق Django

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

تأتي تطبيقات Django مزودة بقاعدة بيانات SQLited ، لذلك لن تضطر إلى تثبيت قاعدة بيانات أخرى.

لإنشاء تطبيق Django ، قم أولاً بإنشاء مشروع يسمى طعام بالأمر التالي:

بدء مشروع django-admin للأغذية

بعد ذلك ، قم بإنشاء تطبيق Django يسمىأطعمة كينية:

django-admin startapp kenyanfood

3. تسجيل إعدادات مشروع التطبيق

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

# تعريف التطبيق
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'أطعمة كينية',
'بقية الإطار',
]

4. تسجيل عناوين URL للتطبيق

يسجل أطعمة كينية عناوين URL للتطبيق في المشروع urls.py الملف كما هو موضح أدناه:

من django.contrib يستورد مسؤل
من django.urls يستورد المسار ، وتشمل
أنماط عنوان url = [
 طريق('مسؤل/'، admin.site.urls) ،
 طريق(''، يشمل('kenyanfood.urls')),
]

5. إنشاء طريقة عرض لواجهة برمجة التطبيقات

إنشاء عرض وهمي في التطبيق views.py الملف ، لذلك التطبيق لا يتخلص من الأخطاء. أولاً ، قم باستيراد ملف إجابة الاعتراضتضمين التغريدة مصمم من إطار Django REST.

إجابة يساعد في إعادة البيانات المعقمة بتنسيق جسون تنسيق بينما ملف تضمين التغريدة يعرض API.

من django.shortcuts يستورد يجعل
من rest_framework.r response يستورد إجابة
من rest_framework.decorators يستورد api_view
# قم بإنشاء وجهات نظرك هنا.
api_view (['يحصل'])
defgetFood(طلب):
يعود إجابة()

6. قم بإنشاء مسار URL للتطبيق

قم بإنشاء مسار URL لعرض API الذي قمت بإنشائه. تعرض نقطة النهاية هذه ملف أطعمة كينيةبيانات.

من django.urls يستورد طريق
من. يستورد الآراء
من django.conf يستورد إعدادات
أنماط عنوان url = [
 طريق(''، views.getFood)،
 طريق('بريد/'، views.postFood)،
]

7. قم بإنشاء نموذج للتطبيق

يتم استدعاء فئة نموذج التطبيق طعام. يجب أن تبدو هذه:

من django.db يستورد عارضات ازياء
# قم بإنشاء النماذج الخاصة بك هنا.
فصلطعام(عارضات ازياء. نموذج):
 الاسم = النماذج. CharField (max_length = 200)
 الوصف = النماذج. CharField (max_length = 500)

قم بتسجيل النموذج في التطبيق admin.py الملف كما هو موضح أدناه:

من django.contrib يستورد مسؤل
من .عارضات ازياء يستورد طعام
# سجل النماذج الخاصة بك هنا.
مسؤل.موقع.يسجل(طعام)

8. قم بالهجرات

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

الثعبانيدير.السنة التحضيريةالهجراتأطعمة كينية

بعد ذلك ، قم بتطبيق عمليات الترحيل هذه عن طريق تشغيل هذا الأمر:

الثعبانيدير.السنة التحضيريةيهاجر

سيبدو الترحيل الناجح على النحو التالي:

تعني عمليات الترحيل الناجحة أن قاعدة البيانات قد أنشأت جداول لـ أطعمة كينيةبرنامج.

9. أضف البيانات إلى قاعدة البيانات

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

بدلاً من ذلك ، يمكنك استخدام python shell في سطر الأوامر لإدخال البيانات يدويًا في قاعدة البيانات. في هذا الدليل ، سوف تستخدم واجهة إدارة Django.

استخدم الأمر التالي لإعداد مسؤول Django:

الثعبانيدير.السنة التحضيريةالخالق

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

http://127.0.0.1:8000/admin/

سترى صفحة تسجيل الدخول:

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

يمكنك إضافة وحذف طعام عناصر من قاعدة البيانات من صفحة المسؤول. أضف بعض الأطباق الكينية الشهية ، مثل Ugali و Pilau و Chai ، إلى قاعدة البيانات.

الآن بعد أن أصبحت قاعدة البيانات تحتوي على بيانات ، قم بإنشاء API

10. تسلسل النموذج

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

قم بإنشاء ملف جديد في التطبيق يسمى متسلسل

من بقية الإطار يستورد المسلسلات
من .عارضات ازياء يستورد طعام
فصلالغذاء(مسلسلات. الموديل:
فصلميتا:
 النموذج = طعام
 الحقول = ('اسم','وصف')

تقوم باستيراد ملف المسلسلات وحدة من بقية الإطار الحزمة وإنشاء ملف الغذاء الطبقة التي ترث من الموديل فصل.

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

11. قم بتحديث العرض

بعد ذلك ، قم بتحديث عرض API بامتداد المسلسل و طعام عارضات ازياء.

أولاً ، حدد ملف يحصل طريقة لاسترداد جميع البيانات من قاعدة البيانات مع طعام. Objects.all () وظيفة. ثم تسلسل البيانات وإعادتها كرد بتنسيق جسون شكل.

من django.shortcuts يستورد يجعل
من rest_framework.r response يستورد إجابة
من rest_framework.decorators يستورد api_view
من .عارضات ازياء يستورد طعام
من .serializer يستورد الغذاء
# قم بإنشاء وجهات نظرك هنا.
api_view (['يحصل'])
defgetFood(طلب):
 food = Food.objects.all ()
 المتسلسل = FoodSerializer (طعام ، كثير =حقيقي)
يعود الاستجابة (serializer.data)

بعد ذلك ، انتقل إلى رابط عنوان URL للخادم:

https://127.0.0.1:8000/

سترى واجهة برمجة التطبيقات تعرض البيانات من قاعدة البيانات:

تهانينا ، لقد أنشأت REST API!

12. أضف البيانات بطريقة POST

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

أولاً ، حدد ملف بريد الطريقة في العرض.

api_view (['بريد'])
defبوست فوود(طلب):
 المتسلسل = FoodSerializer (البيانات = request.data)
لوالمسلسل.صالح():
المسلسل.يحفظ()
يعود الاستجابة (serializer.data)

ثم أضف مسارًا في التطبيق urls.py لإنشاء نقطة نهاية لواجهة برمجة التطبيقات بريد وظائف.

أنماط عنوان url = [
 طريق(''، views.getFood)،
 طريق('بريد/'، views.postFood)،
]

بعد ذلك ، انتقل إلى عنوان URL هذا:

https://127.0.0.1:8000/post

سترى ملف بريد نقطة النهاية. أضف البيانات إلى قاعدة البيانات بتنسيق جسون بتنسيق محتوى قسم وانقر فوق بريد زر. على سبيل المثال ، أضف عنصرًا غذائيًا جديدًا بهذه البنية:

{ "اسم":"Maziwa مالا", "وصف":"لبن رائب" }

سترى البيانات معروضة باللون الأحمر في جسون شكل.

الآن ، إذا عدت إلى ملف يحصل نقطة النهاية http://127.0.0.1:8000/، سترى الطعام "مازيوا مالا " ووصفه مضاف.

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

كيفية إنشاء REST API مع Django

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

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