تمرين - تحديث واجهة برمجة تطبيقات ويب Python باستخدام GitHub Copilot

  • 5 دقائق

دعونا نستكشف كيف يمكنك تعديل مستودع Python باستخدام اقتراحات التعليمات البرمجية من GitHub Copilot لإنشاء نموذج HTML تفاعلي ونقطة نهاية واجهة برمجة التطبيقات (API). من خلال العمل مع هذا المستودع، يمكنك الحصول بسرعة على التدريب العملي باستخدام تطبيق ويب Python الذي يخدم واجهة برمجة تطبيقات HTTP التي تنشئ رمزا مميزا عشوائيا مستعارا، يستخدم عادة في إجراءات التعريف.

ما هي واجهة برمجة التطبيقات؟

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

توسيع واجهة برمجة تطبيقات الويب

تحتوي واجهة برمجة التطبيقات بالفعل على نقطة نهاية واحدة لإنشاء رمز مميز. لنحدث واجهة برمجة التطبيقات عن طريق إضافة نقطة نهاية جديدة تقبل النص وتعيد قائمة بالرموز المميزة.

إشعار

لهذا التمرين، استخدم Codespace مع البيئة التي تم تكوينها مسبقا في المستعرض الخاص بك.

الخطوة 1: إضافة نموذج Pydantic

انتقل إلى main.py الملف، وأضف تعليقا بحيث يمكن ل GitHub Copilot إنشاء Pydantic نموذج لك. يجب أن يبدو النموذج الذي تم إنشاؤه مثل هذا المثال:

class Text(BaseModel):

text: str

الخطوة 2: إنشاء نقطة نهاية جديدة

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

# Create a FastAPI endpoint that accepts a POST request with a JSON body containing a single field called "text" and returns a checksum of the text

الخطوة 3: إضافة عمليات الاستيراد الضرورية

يمكن أن تتسبب التعليمات البرمجية التي تم إنشاؤها في تعطل التطبيق إذا لم يتم استيراد الوحدات base64 النمطية و os . استخدم GitHub Copilot Chat لتطلب من Copilot مساعدتك في إضافة عمليات الاستيراد المفقودة.

بدلا من ذلك، أضف الأسطر التالية إلى أعلى الملف:

import base64
import os

وأخيرا، تحقق من أن نقطة النهاية الجديدة تعمل. جرب ذلك بالانتقال إلى /docs نقطة النهاية والتأكد من ظهور نقطة النهاية.

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

عند الانتهاء من التمرين في GitHub، ارجع هنا من أجل:

  • اختبار سريع للمعلومات
  • ملخص ما تعلمته
  • شارة إكمال هذه الوحدة