JSON या आपके पहले API एप्लिकेशन से डरो मत

मेरे पास कुछ 8 वर्षों का अनुभव लेने वाला कोड है। इस समय के दौरान, मैं कई अलग-अलग भाषाओं और तकनीकों को अलग-अलग दिशाओं में आज़माने में कामयाब रहा: पीएचपी डेवेल स्टूडियो पर हर तरह के फ़िशिंग चुटकुलों के "विकास" से लेकर आधुनिक फ्रेमवर्क और न्यूरल नेटवर्कों पर सॉफ्टवेयर तक। वैसे, प्रोग्रामिंग में मेरा पहला विसर्जन 12 साल की उम्र में इस पद के लिए हुआ। अब मैं कंप्यूटर विज्ञान में स्नातक की डिग्री के अपने दूसरे वर्ष में हूं। हाल ही में, अर्थात्, पहले वर्ष तक, लंबे समय तक मैं हमेशा हर बार डरता था जब मैंने JSON शब्द देखा। समझ गए और समझ गए। लेकिन मैंने देखा कि मेरे समूह के कई लोगों ने अभी भी किसी भी एपीआई के साथ काम नहीं किया है। मुझे उन लेखों से प्यार है जहां लेखक अपने विषय को विस्तार से बताता है, कोड के टुकड़े संलग्न करता है और चबाता है कि उसने ऐसा करने का फैसला क्यों किया, और खुद को जटिल शब्दों और प्रौद्योगिकियों पर नहीं फेंकता है। इस लेख में मैं एक नौसिखिया के लिए सरल शब्दों के साथ एपीआई के उपयोग (PUBG एपीआई का एक उदाहरण के रूप में) का वर्णन करूंगा, जैसा कि वे कहते हैं, बिना बकवास के। चलो चलते हैं!

गूगल कोलाब

इस लेख को पूरा करने के लिए, आपको पायथन के न्यूनतम ज्ञान की आवश्यकता होगी। "न्यूनतम" से मेरा मतलब है प्रिंट, अगर, के लिए, अच्छी तरह से, सभी प्रकार की चादरें, शब्दकोश। हम Google सहयोगी वातावरण (इसके बाद - बस "कोलाब") में काम करेंगे। कोलाब एक मुक्त ब्राउज़र वातावरण है जहां स्मार्ट लोग कृत्रिम बुद्धिमत्ता के साथ अपने कार्यक्रमों को प्रशिक्षित करते हैं और सभी प्रकार के अनुसंधान करते हैं। लेकिन अब हमारे लिए यह महत्वपूर्ण नहीं है, हम कोड लिखने के लिए प्रारूप में रुचि रखते हैं: वहां निष्पादित फ़ाइलों को "लैपटॉप" (अंग्रेजी से - एक नोटबुक) कहा जाता है। इस प्रारूप में, कोड को सीधे ब्राउज़र में टुकड़ों में (कोलैब में कोड का एक टुकड़ा "कोड सेल") लिखा और निष्पादित किया जा सकता है।

आइए कोशिश करते हैं:

1. हम Google Colab पर जाते हैं और अपने Google खाते से लॉग इन करते हैं
2. कोलाब का उपयोग कैसे करें, इसकी मदद से हमें मुख्य पृष्ठ द्वारा अभिवादन किया जाएगा, और हम ऊपरी बाएँ कोने में फ़ाइल> नई पायथन 3 नोटबुक पर क्लिक करके अपना पहला लैपटॉप बनाते हैं।
   
   कुछ सेकंड में, हमें कुछ इसी तरह देखना चाहिए:
   
   
3. निम्नलिखित कीबोर्ड शॉर्टकट याद रखें :
   Ctrl + Enter (Cmd + Enter for MacOS) - वर्तमान कोड सेल चलाएँ
   ALT + Enter (MacOS के लिए विकल्प + दर्ज करें) - वर्तमान कोड सेल चलाएं, बनाएं और नए कोड सेल पर जाएं
   

कोड सेल में, आप तुरंत नियमित अजगर कोड लिख सकते हैं। यदि हम कुछ कंसोल कमांड निष्पादित करना चाहते हैं, तो एक विस्मयादिबोधक चिह्न लाइन से पहले डाला जाता है, उदाहरण के लिए:

पायथन कोड

print('Hello, PUBG!') 

कंसोल टीम

 !mkdir hello_pubg !cd hello_pubg 

आइए, किसी प्रकार के सरल एल्गोरिथम को निष्पादित करने का प्रयास करें, उदाहरण के लिए, दो संख्याओं का सबसे बड़ा सामान्य विभाजक ढूंढना:

1. कोड सेल में हम दर्ज करते हैं:
   
   

    a = 10 b = 8 

   
   
2. Alt + Enter दबाएं (MacOS के लिए विकल्प + दर्ज करें) और नए कोड सेल में लिखें:
   
   

    while a != 0 and b != 0: if a > b: a %= b else: b %= a gcd = a + b 

   
   
3. Alt + फिर से दबाएं (विकल्प + MacOS के लिए दर्ज करें) और नए कोड सेल में लिखें:
   
   

    print(gcd) 

   
   और Ctrl + Enter (Cmd + Enter for MacOS) दबाएँ। हमें उत्तर मिलता है: २
   
   
   

जैसा कि आप देख सकते हैं, कोलाब में काम करना बहुत सरल है और आपके भविष्य के एप्लिकेशन की कुछ कार्यक्षमता का परीक्षण करना यहां बहुत सुविधाजनक है। वैसे, यदि हम एल्गोरिदम को अन्य नंबरों के साथ निष्पादित करना चाहते हैं, तो हमें पहले कोड सेल में चर के मूल्यों को बदलना होगा, इसे शुरू करना होगा, फिर दूसरा और फिर तीसरा शुरू करना होगा।

हम लैपटॉप को बंद नहीं करते हैं, चलो आगे बढ़ते हैं।

PUBG एपीआई

अब सरल शब्दों में एक एपीआई क्या है। जब भी हम किसी साइट पर जाते हैं, तो इस साइट का सर्वर हमें HTML कोड के साथ उत्तर देता है, अर्थात, उदाहरण के लिए, google.com पर जाकर, Google सर्वर हमारे ब्राउज़र पर HTML भेजता है, जो ब्राउज़र द्वारा ही संसाधित होता है, और ब्राउज़र हमें एक सुंदर दिखाता है एक चित्र, सभी शैलियों को संसाधित करना, आदि। लेकिन यह हमेशा नहीं होता है, उदाहरण के लिए, इस लिंक का अनुसरण करते हुए , हम प्रिंट () कमांड के साथ अजगर में एक शब्दकोश के आउटपुट के समान कुछ देखेंगे। तो यह है। यह वर्तमान मौसम की जानकारी का एक शब्दकोश है जो हमें ओपनवार्टरमैप से मिला है। और एक व्यक्ति अपने दम पर सर्वर से इस तरह की प्रतिक्रियाओं को कभी नहीं संभाल पायेगा। इस साइट के डेवलपर्स ने हमें ऐसे लिंक प्रदान किए हैं ताकि हम उन्हें अपने कार्यक्रमों में उपयोग कर सकें। सामान्य तौर पर, अगर हमें अपनी वेबसाइट या एप्लिकेशन पर एक मौसम ब्लॉक बनाने की आवश्यकता होती है, तो हम ओपनवाइटरमैप (या कोई अन्य एनालॉग जो एपीआई प्रदान करता है) पर जाते हैं, उनके दस्तावेज खोलते हैं और उसका उपयोग करते हैं। डिकोडिंग और अनुवाद में रूसी एक "एप्लिकेशन प्रोग्रामिंग इंटरफ़ेस" की तरह लगता है, अर्थात् , फॉर्म साइट. com / request के अनुरोधों का एक संग्रह है, जो हमें आवश्यक जानकारी के साथ एक शब्दकोश लौटाता है। और इन शब्दकोशों के प्रारूप को JSON कहा जाता है। एक XML प्रारूप भी है, लेकिन हम इस लेख में इसका विश्लेषण नहीं करेंगे।

सबसे पहले, मैंने लिखा है कि हम खेल PUBG के डेवलपर्स से आधिकारिक एपीआई का उपयोग करेंगे। चलिए शुरू करते हैं। यहां वह संसाधन है जिसके साथ हम प्राप्त गठन को सत्यापित करेंगे, इसे एक नए टैब में खोलें और खिलाड़ियों की तलाश में किसी भी खिलाड़ी का उपनाम दर्ज करें, उदाहरण के लिए, "Twitch_todol"। इस खिलाड़ी के आँकड़े खुलते हैं:



हम उनका अंतिम मैच (सूची में पहला) खोलते हैं और वे सभी जानकारी देखते हैं जिनकी हमें आवश्यकता है:



PUBG API से इस मैच के बारे में जानकारी प्राप्त करने के लिए:

1. हम PUBG डेवलपर के आधिकारिक पृष्ठ पर जाते हैं ।
   
2. अपना खुद का एपीआई कुंजी बटन प्राप्त करें पर क्लिक करके पेज पर लॉग इन करें या रजिस्टर करें। और इससे कोई फर्क नहीं पड़ता कि हमने यह खेल खेला है या नहीं। हमें इस साइट से अपना टोकन प्राप्त करने की आवश्यकता है, अर्थात् एपी कुंजी।
   
   हर बार, किसी भी जानकारी के लिए PUBG सर्वर की ओर मुड़ते हुए, हमें इसे अपने अनूठे टोकन के साथ प्रदान करना होगा। यह विभिन्न कारणों से किया गया था, सबसे स्पष्ट है कि खेल के डेवलपर्स को पता चल सकता है कि कौन वास्तव में अपने सर्वर से जानकारी प्राप्त करता है और अपने प्रोग्रामर के लिए प्रतिबंध लगाता है। इस मामले में, हमारे पास एक सीमा है - प्रति मिनट 10 से अधिक अनुरोध नहीं। यह हमारे लिए पर्याप्त से अधिक है।
   
3. हम एप्लिकेशन बनाते हैं और अपना टोकन प्राप्त करते हैं
   
   
   
   फिलहाल, यह बहुत महत्वपूर्ण नहीं है कि हमने यहां क्या दर्ज किया है। हम बनाएँ ऐप पर क्लिक करें और वर्णों का एक लंबा सेट देखें, इस प्रकार के बारे में (अपना खुद का उपयोग करें, यह काम नहीं करता है):
   
   

    eyJ0eXAiOiJKV1QiLWFeCJhbGciOiJIUzI1NiJ9.eyJqdGkiOiI5ZjIwYTJkMC0xMzYwLTAxMzgtZTFhYS03ZDVjOWM4YTdjZWUiLCJpc3MiOiJnYW1lbG9ja2VyIiwiaWF04IjoxNTc4MzkwNDQwLCJwdWIiOiJibHVlaG9sZSIsInRpdGxlIjoicHViZyIsImFwcCI6ImxlYW5jb3JlZ2ctZ21hIn0.fwFwEeEw3OghE8sACAHbpKWlJFBVo6F_DbB7dbanybLIIToJc4 

   
   
4. अपने टोकन को कॉपी करें और अपने टैब को कोलाब के साथ खोलें। आपने इसे बंद नहीं किया, क्या आपने?
   
5. पहले कोड सेल में हम इस कोड को दर्ज करते हैं:
   
   

    import requests url = "endpoint-url" API_KEY = '< >' header = { "Authorization": "Bearer " + API_KEY, "Accept": "application/vnd.api+json" } 

   
   और दौड़ो। इस कोड के कोड में, हमने एक शब्दकोश (हेडर) बनाया, जिसमें PUBG API को एक्सेस करने के लिए बुनियादी पैरामीटर हैं। हम इस शब्दकोश को हर बार सर्वर से भेजेंगे। सशर्त रूप से, हम सर्वर को "हैलो, मेरा नाम पेट्या," बताते हैं - जहां पेट्या हमारा टोकन है - "मैं आपसे JSON प्रारूप में जानकारी प्राप्त करना चाहता हूं!" मुझे इस पृष्ठ पर PUBG API दस्तावेज़ीकरण से मिला कोड का टुकड़ा मिला।
   
6. अब हमें यह बताने की आवश्यकता है कि हमें सर्वर से क्या प्राप्त करने की आवश्यकता है। हमारे मामले में, हम उसे Twitch_todol खिलाड़ी के अंतिम गेम से प्राप्त करना चाहते हैं। खिलाड़ी के बारे में जानकारी के लिए, हम एक अनुरोध करते हैं
   api.pubg.com/shards/steam/players?filter [playerNames] = Twitch_todol
   
   वह है (नए कोड सेल में):
   
   

    player_name = 'Twitch_todol' r = requests.get('https://api.pubg.com/shards/steam/players?filter[playerNames]=' + player_name, headers=header) player = r.json() 

   
   जहां दूसरी पंक्ति में हम फ़ंक्शन लाइब्रेरी से फ़ंक्शन का उपयोग करते हैं, जहां पहला पैरामीटर वह है जो हमें सर्वर से चाहिए, और दूसरा पैरामीटर हमारे हेडर शब्दकोश है। दूसरे शब्दों में, हम सर्वर से कहते हैं “हेलो, मैं पीटर हूँ! मैं आपसे JSON प्रारूप में Twitch_todol खिलाड़ी के बारे में जानकारी प्राप्त करना चाहता हूं। "
   
   और तीसरी पंक्ति में, हम सर्वर से प्रतिक्रिया को इसी JSON में अनुवादित करते हैं। हम ऐसा क्यों कर रहे हैं? तथ्य यह है कि सर्वर हमारे लिए एक प्रतिक्रिया नहीं लौटाता है, लेकिन एक स्ट्रिंग में अनुवादित जोंस। और .json () विधि के साथ, हम इस स्ट्रिंग को एक शब्दकोश में परिवर्तित करते हैं जिसे पायथन समझता है।
   
   आइए नए कोड सेल में लिखकर यह सुनिश्चित करें:
   
   

    type(player) 

   
   इसका जवाब बड़ा स्पष्ट है। यही है, अब हम यह सुनिश्चित करने के लिए जानते हैं कि खिलाड़ी चर में एक शब्दकोश है जो खिलाड़ी के बारे में जानकारी के साथ अजगर के लिए समझ में आता है।
   
7. वास्तव में इस शब्दकोष में क्या है? चलिए देखते हैं
   
   

    player.keys() 

   
   हम उत्तर देखते हैं:
   
   dict_keys (['डेटा', 'लिंक', 'मेटा'])
   
   ये हमारे शब्दकोश की कुंजी हैं। उनमें से प्रत्येक में क्या है इस पृष्ठ पर लिखा गया है।
   
   यह सुनिश्चित करने के लिए कि हमें वह खिलाड़ी मिले जिसकी हमें आवश्यकता है, हम निम्नलिखित लिखेंगे:
   
   

    player['data'][0]['attributes'] 

   
   यहां हम खिलाड़ी के बारे में बुनियादी जानकारी देखते हैं: जब उसने पंजीकृत किया, तो उसका उपनाम, वह किस मंच पर खेलता है, इत्यादि।
   
8. हमें उसके अंतिम मैच की आईडी प्राप्त करने की आवश्यकता है, जिसे हम pubg.op.gg वेबसाइट से सत्यापित कर सकते हैं, जो पहले से ही हमारे ब्राउज़र टैब में खुला है। इसके लिए हम लिखते हैं:
   
   

    player['data'][0]['relationships']['matches']['data'][0]['id'] 

   
   हमें 'ca2c453b-649a-4556-b768-66b9e01aae63' के समान कुछ मिला (आपका अलग हो सकता है, क्योंकि इस लेख को पढ़ने के समय खिलाड़ी पहले ही कई मैच खेल सकता है)। आपको जो मिला है, उसका उपयोग करें। मैं आपको एक उदाहरण देता हूं ताकि आप भ्रमित न हों।
   
   तो, हम मैच की आईडी जानते हैं, अब इस मैच के बारे में जानकारी प्राप्त करते हैं, इसके लिए हम वैरिएबल मैच_आईडी बनाते हैं, जिसे हम प्राप्त आईडी के बराबर बनाते हैं। और हम कुछ अलग पते पर अनुरोध करते हैं, लेकिन सामान्य योजना के अनुसार, यह है:
   
   

    match_id = player['data'][0]['relationships']['matches']['data'][0]['id'] # id  r = requests.get('https://api.pubg.com/shards/steam/matches/' + match_id, headers=header) match = r.json() 

   
   
9. मैच चर, जो एक शब्दकोश है, इस मैच के बारे में सारी जानकारी रखता है। आरंभ करने के लिए, हम इस मैच में सभी खिलाड़ियों का प्रदर्शन प्राप्त करते हैं:
   
   

    match_players = [item for item in match['included'] if item['type'] == 'participant'] match_players 

   
   इस मामले में, हम खिलाड़ियों की सूची (match_players) भरते हैं, शब्दकोश मैच के माध्यम से जा रहे हैं ['शामिल'] ('शामिल' 'शब्दकोश शब्दकोश की कुंजी है जिसमें मैच के सभी खिलाड़ियों के संकेतक शामिल हैं), साथ ही कुंजी' प्रकार 'के मूल्य की जांच करते हैं। हम क्यों जाँचते हैं
   मैच ['शामिल'] खिलाड़ी जानकारी शामिल है? तथ्य यह है कि यह पूरी तरह से सच नहीं है, मैच ['शामिल'] में उन टीमों के बारे में भी जानकारी होती है, जिनमें ये खिलाड़ी खेलते हैं (यानी, आइटम ['प्रकार'] 'रोस्टर' के बराबर हो सकता है)। यह है, मैच ['शामिल'] कुछ इस तरह दिखता है:
   
   [खिलाड़ी, टीम, टीम, खिलाड़ी, खिलाड़ी, खिलाड़ी, टीम, ...]
   
   यह पूरी तरह से स्पष्ट नहीं है कि डेवलपर्स ने ऐसा करने का फैसला क्यों किया, लेकिन यह हमें किसी भी तरह से परेशान नहीं करता है।
   
   इसलिए, हमें खिलाड़ियों का प्रदर्शन मिला है, लेकिन हम इस मैच में अन्य खिलाड़ियों के प्रदर्शन के बारे में विशेष रूप से दिलचस्पी नहीं रखते हैं, हम इस मैच में अपने खिलाड़ी ट्विच_टॉडोल के प्रदर्शन को देखेंगे। ऐसा करने के लिए, हम प्रदर्शन करते हैं:
   
   

    my_player_stats = [item for item in match_players if item['attributes']['stats']['name'] == player_name][0] my_player_stats 

   
   

परिणामी आँकड़ों की तुलना करें:



pubg.op.gg पर आंकड़ों के साथ



हम देखते हैं कि सब कुछ मेल खाता है। ख़ुश हो जाओ! वैसे, जब मैं यह लेख लिख रहा था, हमारे हीरो ने पहले ही कई मैच खेलने में कामयाबी हासिल कर ली है, इसलिए मेरे द्वारा ऊपर दिए गए कुछ स्क्रीनशॉट शायद मेल न खाएं।

समापन

इस लेख में मैं हमारे सबसे छोटे प्रोग्रामर को बताना चाहता था कि आपको JSON और API शब्द से डरना नहीं चाहिए, ताकि वे आसानी से और स्पष्ट रूप से कार्यान्वित हो सकें और प्रत्येक में प्रलेखन संलग्न हो। मैंने जटिल शब्दों का उपयोग किए बिना, सबसे सुलभ भाषा में इसे समझाने की कोशिश की।

और साथ ही, मैं 8 साल पहले पहली बार कोड लिखने में मेरी मदद करने के लिए हैबर और लेखक ( अरहमैक्स ) को धन्यवाद देना चाहता हूं।