व्यायाम - GitHub Copilot के साथ एक वेब एपीआई अपडेट करें
आइए जानें कि आप एपीआई एंडपॉइंट के लिए उन्नत GitHub Copilot तकनीकों का उपयोग करके पायथन रिपॉजिटरी को कैसे संशोधित कर सकते हैं। इस रिपॉजिटरी का उपयोग करके अधिक व्यावहारिक अनुभव प्राप्त करें जिसमें एक पायथन वेब एप्लिकेशन है जो ट्रैवल वेदर एपीआई होस्ट करता है।
एपीआई क्या है?
एक एपीआई मध्यस्थ के रूप में कार्य करता है जो विभिन्न अनुप्रयोगों को एक दूसरे से संवाद करने की अनुमति देता है। उदाहरण के लिए, एक मौसम वेबसाइट या तो ऐतिहासिक डेटा साझा कर सकती है या अपने एपीआई के माध्यम से पूर्वानुमान कार्यक्षमता प्रदान कर सकती है। एपीआई का उपयोग करके, आप डेटा को अपनी वेबसाइट में एम्बेड कर सकते हैं, या अन्य सुविधाओं के साथ मौसम डेटा साझा करने वाला एप्लिकेशन बना सकते हैं।
वेब API का विस्तार करें
वर्तमान एपीआई देश/क्षेत्र को उजागर नहीं कर रहा है, जिसे शहरों को सूचीबद्ध करने के लिए लागू करने की आवश्यकता है। मार्ग को केवल JSON प्रतिक्रिया के साथ GET HTTP अनुरोधों की अनुमति देनी चाहिए जो उस देश/क्षेत्र, शहर और दिए गए महीने के लिए ऐतिहासिक उच्च और निम्न से जानकारी प्रदान करते हैं।
नोट
इस अभ्यास के लिए, अपने ब्राउज़र में पहले से कॉन्फ़िगर किए गए परिवेश के साथ कोडस्पेस का उपयोग करें।
चरण 1: एक नया मार्ग जोड़ें
main.py फ़ाइल खोलें, और Ctrl+i (Windows पर) या Command+i (Mac पर) कमांड के साथ इनलाइन चैट का उपयोग करें। यह कमांड GitHub Copilot को एक नया API बनाने में आपकी मदद करने के लिए कहता है जो आपको किसी देश/क्षेत्र के शहर दिखाता है। निम्न संकेत का उपयोग करें:
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 Chat के साथ एक परीक्षण बनाएं जो स्पेन को देश/क्षेत्र के रूप में उपयोग करता है। अपना कोड चुनना याद रखें, और Copilot Chat से इस विशिष्ट API के साथ आपकी सहायता करने के लिए कहें जिसे हमने अभी बनाया है। आप निम्न संकेत के साथ इनलाइन-चैट या समर्पित चैट फलक का उपयोग कर सकते हैं:
/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: दस्तावेज़ लिखने के लिए एक एजेंट का उपयोग करें
अंत में, प्रोजेक्ट दस्तावेज़ीकरण और प्रोजेक्ट को चलाने के तरीके के बारे में विवरण लिखने के लिए GitHub Copilot चैट एजेंट मोड का उपयोग करें।
README.md फ़ाइल खोलें और GitHub Copilot चैट में निम्न संकेत का उपयोग करें:
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 में अभ्यास समाप्त कर लें, तो इसके लिए यहां लौटें:
- एक त्वरित ज्ञान जांच
- आपने जो सीखा है उसका सारांश
- इस मॉड्यूल को पूरा करने के लिए एक बैज