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

مكتمل

دعونا نستكشف كيف يمكنك تعديل مستودع Python باستخدام تقنيات GitHub Copilot المتقدمة لنقطة نهاية واجهة برمجة التطبيقات. اكتساب المزيد من الخبرة العملية باستخدام هذا المستودع الذي يحتوي على تطبيق ويب Python الذي يستضيف واجهة برمجة تطبيقات طقس السفر.

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

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

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

لا تعرض واجهة برمجة التطبيقات الحالية البلد/المنطقة، والتي يجب تنفيذها لإدراج المدن. يجب أن يسمح المسار فقط بطلبات GET HTTP مع استجابة JSON التي توفر معلومات من الأعلى والمنخفض التاريخي لهذا البلد/المنطقة والمدينة والشهر المحدد.

إشعار

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

الخطوة 1: إضافة مسار جديد

افتح ملف main.py، واستخدم الدردشة المضمنة مع الأمر Ctrl+i (على Windows) أو Command+i (على Mac). يطلب هذا الأمر من GitHub Copilot مساعدتك في إنشاء واجهة برمجة تطبيقات جديدة تعرض لك مدن بلد/منطقة. استخدم المطالبة التالية:

Create a new route that exposes the cities of a country/region.

يجب أن تمنحك هذه المطالبة شيئا مشابها لهذا:

# Create a new route that exposes the cities of a country:
@app.get('/countries/{country}')
def cities(country: str):
    return list(data[country].keys())

إشعار

جرب مسارك الجديد وصقل مطالبتك حتى تصبح النتيجة كما تريد.

الخطوة 2: إنشاء اختبار

الآن بعد أن أنشأت مسارا جديدا، أنشئ اختبارا باستخدام دردشة Copilot لهذا المسار الذي يستخدم إسبانيا كبلد/منطقة. تذكر تحديد التعليمات البرمجية الخاصة بك، واطلب من Copilot Chat مساعدتك في واجهة برمجة التطبيقات المحددة هذه التي أنشأناها للتو. يمكنك استخدام الدردشة المضمنة أو جزء الدردشة المخصص مع المطالبة التالية:

/tests help me to create a new test for this route that uses Spain as the country/region.

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

This test is not quite right, it is not including cities that doesn't exist. Only Seville is part of the API.

الخطوة 3: استخدام عامل لكتابة الوثائق

وأخيرا، استخدم وضع وكيل الدردشة Copilot في GitHub لكتابة توثيق المشروع وتفاصيل كيفية تشغيل المشروع نفسه. افتح README.md الملف واستخدم المطالبة التالية في GitHub Copilot Chat:

I want to document how to run this project so that other developers can get started quickly by reading the README.md file.

يجب أن تحصل على استجابة تساعدك على تحديث ملف README.md بالمعلومات الضرورية لتشغيل المشروع.

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

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

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