Python APIs में महारत: Python में APIs बनाने और उपयोग करने की विस्तृत मार्गदर्शिका

API (Application Programming Interfaces) आधुनिक सॉफ़्टवेयर विकास के असली नायक हैं। ये अलग-अलग सॉफ़्टवेयर सिस्टम्स को आपस में संवाद करने देते हैं, जिससे सेवाओं का एकीकरण और ऐप्लिकेशन बनाना संभव होता है। APIs में महारत हासिल करना, विशेषकर यदि आप डेवलपर हैं, तो Python में डेटा के साथ काम करने के इच्छुक किसी भी व्यक्ति के लिए एक महत्वपूर्ण कौशल है। यह कौशल सीखने पर आपके सामने कई रास्ते खुल जाते हैं—आप वेब ऐप्लिकेशन बना सकते हैं, बाहरी सेवाओं से कनेक्ट कर सकते हैं, या मशीन लर्निंग परियोजनाओं में वास्तविक-समय डेटा का उपयोग कर सकते हैं।

इस मार्गदर्शिका में, हम APIs की दुनिया को समझेंगे, Python में उनका उपयोग करना सीखेंगे, FastAPI के साथ अपनी खुद की API बनाना देखेंगे, और सामान्य चुनौतियों से निपटने के तरीकों पर चर्चा करेंगे। इस ट्यूटोरियल के अंत तक, आपके पास अपने प्रोजेक्ट्स में APIs का उपयोग करने की ठोस समझ होगी, जिससे आपका विकास-कार्य अधिक कुशल और आपके ऐप्लिकेशन अधिक शक्तिशाली बनेंगे। यदि आपको जानकारी के भंडार के बीच कभी अटकन महसूस हो, तो हमारा Introduction to APIs in Python कोर्स देखें, जो हर हिस्से को विस्तार से समझाता है।

API क्या है?

API अलग-अलग सॉफ़्टवेयर ऐप्लिकेशन्स के बीच एक पुल की तरह है। यह इन ऐप्लिकेशन्स को आपस में संवाद करने और जानकारी साझा करने देता है।

API को रेस्टोरेंट में वेटर की तरह समझें। आप वेटर को बताते हैं कि आपको क्या चाहिए (आपका ऑर्डर), और वह आपकी मांग को किचन तक पहुँचाता है। किचन खाना तैयार करता है, और वेटर उसे आपके पास लाता है। इसी तरह, आप API को एक अनुरोध भेजते हैं, वह उसे प्रोसेस करता है और फिर परिणाम लौटाता है।

इसे और ठोस बनाने के लिए, कुछ वास्तविक उपयोग देखें: आप सार्वजनिक API का उपयोग करके स्टॉक मार्केट विश्लेषण के लिए वित्तीय डेटा प्राप्त कर सकते हैं या जलवायु पूर्वानुमान मॉडल के लिए वास्तविक-समय मौसम डेटा एक्सेस कर सकते हैं। जैसा कि आप देख रहे हैं, बड़े डेटासेट्स के साथ काम करने और/या वास्तविक-समय डेटा की ज़रूरत होने पर APIs विशेष रूप से महत्वपूर्ण हैं; अन्यथा, एकीकरण में शायद दिक्कत न हो।

Python API कैसे काम करती है। छवि: Napkin.AI

Python में APIs का उपयोग

Python में APIs का उपयोग बाहरी सेवाओं से संवाद करने, डेटा प्राप्त करने और अपनी ऐप्लिकेशन्स में विभिन्न क्षमताएँ एकीकृत करने का शक्तिशाली तरीका है। Python इसे requests लाइब्रेरी के ज़रिए सरल और कुशल बनाता है, जो APIs के साथ बातचीत करने के लिए HTTP अनुरोध भेजने देती है।

Python में APIs का परिचय

Python में, requests लाइब्रेरी के कारण APIs से संवाद करना सीधा-सादा है। यह लाइब्रेरी HTTP अनुरोध भेजना सरल बनाती है, जिससे आप APIs से संवाद कर डेटा प्राप्त या भेज सकते हैं।

Python में API अनुरोध करना

API अनुरोध करने से पहले आपको requests लाइब्रेरी की ज़रूरत होगी। आप इसे इस कमांड से इंस्टॉल कर सकते हैं:

pip install requestsसंचालित द्वारा

API अनुरोधों की बुनियाद

रेस्टोरेंट वाले उदाहरण को Python में वास्तव में क्या होता है, उससे जोड़ते हैं। यह सरल विभाजन देखें:

1. सही जगह ढूँढें: API endpoint पहचानें—वह विशिष्ट वेब पता जहाँ आप अपना अनुरोध भेजेंगे।

2. ऑर्डर दें: Python की requests लाइब्रेरी से API को अनुरोध भेजें। आप बताएँगे कि किस प्रकार की कार्रवाई करनी है (जैसे डेटा पाना या डेटा भेजना)।

3. खाना पाएँ: API एक प्रतिक्रिया भेजेगी, जिसे आप प्रोसेस कर अपनी ज़रूरत की जानकारी निकालेंगे।

GET अनुरोध

GET अनुरोध सर्वर से डेटा प्राप्त करने के लिए सबसे सामान्य HTTP अनुरोध है—जैसे जानकारी माँगना। जब आप ब्राउज़र में कोई URL टाइप कर एंटर दबाते हैं, तो आप मूलतः उस सर्वर को GET अनुरोध भेजते हैं, वांछित संसाधन बताते हैं, जिसे सर्वर ढूँढकर तैयार करता है और JSON या XML जैसे फ़ॉर्मैट में लौटा देता है।

import requestsresponse = requests.get('https://api.example.com/data')data = response.json()print(data)संचालित द्वारा

इस उदाहरण में, हम एक काल्पनिक API को GET अनुरोध भेज रहे हैं और JSON प्रतिक्रिया प्रिंट कर रहे हैं। GET अनुरोध आमतौर पर डेटा को बिना बदले प्राप्त करने के लिए उपयोग होते हैं।

POST अनुरोध

जहाँ GET अनुरोध डेटा प्राप्त करते हैं, वहीं POST अनुरोध सर्वर को निर्देश भेजते हैं। ये अक्सर नए संसाधन बनाने (जैसे नया उपयोगकर्ता जोड़ना) या मौजूदा को अपडेट करने (जैसे प्रोफ़ाइल संपादित करना) के लिए उपयोग होते हैं।

कल्पना कीजिए कि आप किसी सेवा के लिए ऑनलाइन फ़ॉर्म भर रहे हैं। सबमिट पर क्लिक करते ही, आप अपनी जानकारी के साथ मूलतः एक POST अनुरोध भेजते हैं। यहाँ एक सरल उदाहरण है:

# Data to send (like user information)data = {'name': 'John Doe', 'email': '[email protected]'}# Send the data to the API (replace the URL with the actual API endpoint)response = requests.post('https://api.example.com/users', json=data)# Check if the request was successful (usually a status code of 201 for creation)if response.status_code == 201:    print("User created successfully!")else:    print("Error:", response.status_code)संचालित द्वारा

यह उदाहरण उपयोगकर्ता जानकारी वाली एक dictionary को JSON डेटा के रूप में API को भेजता है। फिर हम प्रतिक्रिया का स्टेटस कोड जाँचते हैं कि उपयोगकर्ता सफलतापूर्वक बना या नहीं।

प्रतिक्रियाओं को संभालना

जब आप API अनुरोध करते हैं, तो सर्वर एक प्रतिक्रिया भेजता है जिसमें दो प्रमुख बातें होती हैं:

• स्टेटस कोड: एक संख्या जो अनुरोध की सफलता या विफलता बताती है। उदाहरण के लिए, 200 प्रायः सफलता दर्शाता है, जबकि 404 बताता है कि संसाधन नहीं मिला।
• डेटा: आपकी माँगी गई जानकारी, जो अक्सर JSON फ़ॉर्मैट में होती है। यहीं मूल्यवान सामग्री होती है।

यहाँ एक Python उदाहरण है:

response = requests.get('https://api.example.com/data')if response.status_code == 200:    data = response.json()    print(data)   else:    print(f"Request failed with status code {response.status_code}")   संचालित द्वारा

Python API स्टेटस कोड समझना

API स्टेटस कोड मानकीकृत प्रतिक्रियाएँ हैं जिन्हें सर्वर क्लाइंट के अनुरोध के परिणाम को दर्शाने के लिए भेजता है। ये कोड डेवलपर्स को समझने में मदद करते हैं कि अनुरोध सफल हुआ, कोई त्रुटि हुई, या आगे की कार्रवाई की आवश्यकता है।

सामान्य स्टेटस कोड

• 200 OK: यह स्टेटस कोड बताता है कि अनुरोध सफल रहा। जैसे, जब आप डेटा प्राप्त करने के लिए GET अनुरोध करते हैं, तो 200 OK का अर्थ है कि डेटा सही तरह से लाया गया।  

• 404 Not Found: जब सर्वर अनुरोधित संसाधन नहीं ढूँढ पाता, तब यह कोड लौटाता है। उदाहरण के लिए, यदि आप किसी ऐसे endpoint को एक्सेस करते हैं जो मौजूद नहीं, तो आपको 404 Not Found त्रुटि मिलेगी।

• 500 Internal Server Error: यह दर्शाता है कि सर्वर पक्ष पर कुछ गड़बड़ी हुई। यह एक सामान्य त्रुटि संदेश है, जो सर्वर कोड की बग्स या डेटाबेस समस्याओं जैसी विभिन्न वजहों से हो सकता है।

विभिन्न स्टेटस कोड को संभालना

अपने Python ऐप्लिकेशन्स में API स्टेटस कोड को प्रभावी ढंग से संभालने से आपका कोड अनुमानित रूप से व्यवहार करता है और त्रुटियों को गरिमापूर्ण ढंग से मैनेज करता है। यदि प्रतिक्रिया 200 हो, तो लौटाए गए डेटा को प्रोसेस करना जारी रखें। 404 त्रुटि मिलने पर जाँचें कि endpoint URL सही है या नहीं, और आवश्यकता हो तो बैकअप लॉजिक लागू करें या उपयोगकर्ता को सूचित करें कि संसाधन उपलब्ध नहीं है। 500 त्रुटियों के लिए, थोड़ी देरी के बाद अनुरोध फिर से भेजने या त्रुटि को आगे की जाँच के लिए लॉग करने पर विचार करें। हालाँकि, अत्यधिक रीट्राइ से बचें ताकि सर्वर पर अतिरिक्त भार न पड़े।

Python APIs बनाना

Python के साथ APIs बनाना आपको शक्तिशाली और कुशल ऐप्लिकेशन इंटरफेसेज़ तैयार करने देता है। Python की सरलता और मज़बूत लाइब्रेरियाँ API विकास के लिए इसे उत्कृष्ट विकल्प बनाती हैं।

FastAPI का परिचय

अब जब आप APIs का उपयोग करना जानते हैं, आइए देखें कि अपनी खुद की API कैसे बनाते हैं। FastAPI Python के साथ APIs बनाने के लिए एक आधुनिक, तेज़ (हाई-परफॉर्मेंस) वेब फ़्रेमवर्क है। नाम से ही स्पष्ट है, इसे उपयोग में आसान बनाया गया है। FastAPI की एक अच्छी बात यह है कि यह इंटरैक्टिव डॉ큐मेंटेशन स्वतः जनरेट भी करता है।

FastAPI सेटअप करना

शुरू करने के लिए, आपके पास Python और उसका पैकेज मैनेजर pip इंस्टॉल होना चाहिए। इसके बाद, FastAPI और Uvicorn (एक हाई-परफॉर्मेंस ASGI सर्वर) इंस्टॉल करें:

pip install fastapi uvicornसंचालित द्वारा

एक साइड नोट: यदि आपको Python या pip सेटअप में दिक्कत आती है, हमारा ट्यूटोरियल देखें: How to Upgrade Python and Pip in Windows, MacOS, and Linux।

सरल API बनाना

आइए एक सीधी-सादी API बनाते हैं जो एक साधारण अभिवादन लौटाती है:

from fastapi import FastAPIapp = FastAPI()@app.get("/")def read_root():    return {"Hello": "World"}संचालित द्वारा

इस API को चलाने के लिए, यह कमांड चलाएँ:

uvicorn main:app --reloadसंचालित द्वारा

यह कमांड Uvicorn सर्वर शुरू करता है, जो आपकी API को http://127.0.0.1:8000 पर सर्व करता है। इस URL को वेब ब्राउज़र में खोलने पर प्रतिक्रिया में {"Hello": "World"} मिलेगा।

FastAPI की उन्नत विशेषताएँ

FastAPI केवल सरल APIs जल्दी बनाने तक सीमित नहीं है; यह कई उन्नत सुविधाएँ भी देता है जो इसे जटिल और उच्च-प्रदर्शन ऐप्लिकेशन्स के लिए उपयुक्त बनाती हैं। यहाँ कुछ प्रमुख क्षमताएँ हैं: 

Query पैरामीटर्स

FastAPI में Python के टाइप हिंट्स के कारण query पैरामीटर्स जोड़ना और संभालना आसान है। Query पैरामीटर्स URL का हिस्सा होते हैं और API endpoint को वैकल्पिक डेटा पास करने के लिए उपयोग होते हैं, अक्सर लौटाए गए डेटा को फ़िल्टर या संशोधित करने हेतु।

Query पैरामीटर्स जोड़ना

FastAPI में query पैरामीटर जोड़ने के लिए, उसे अपनी path operation फ़ंक्शन में आर्गुमेंट के रूप में परिभाषित करें। यदि पैरामीटर वैकल्पिक है, तो उसे None जैसा डिफ़ॉल्ट मान दे सकते हैं। उदाहरण के लिए, मान लीजिए आपके पास एक endpoint है जो डेटाबेस से items लाता है। आप उपयोगकर्ताओं को सर्च query से items फ़िल्टर करने देना चाहते हैं:

app = FastAPI()@app.get("/items/")def read_items(q: str = None):    if q:        return {"items": ["Item 1", "Item 2", "Item 3"], "query": q}    return {"items": ["Item 1", "Item 2", "Item 3"]}संचालित द्वारा

इस उदाहरण में, q एक वैकल्पिक query पैरामीटर है। यदि हम q का मान देते हैं, तो यह उस query के आधार पर परिणाम फ़िल्टर करता है। यदि q नहीं दिया, तो endpoint सभी items लौटाता है।

Query पैरामीटर्स संभालना

FastAPI स्वचालित रूप से query पैरामीटर्स को संभालता है, जिनमें टाइप वैलिडेशन और कन्वर्ज़न शामिल हैं। उदाहरण के लिए, यदि आप किसी query पैरामीटर को integer के रूप में निर्दिष्ट करते हैं, तो FastAPI सुनिश्चित करेगा कि इनपुट वास्तव में integer हो। यदि इनपुट अपेक्षित प्रकार से मेल नहीं खाता, तो FastAPI स्पष्ट त्रुटि संदेश लौटाएगा।

यहाँ एक आवश्यक query पैरामीटर और टाइप वैलिडेशन के साथ उदाहरण है:

@app.get("/items/{item_id}")def read_item(item_id: int, q: str = None):    return {"item_id": item_id, "query": q}संचालित द्वारा

यहाँ item_id एक path पैरामीटर है, और q वैकल्पिक query पैरामीटर है। FastAPI सुनिश्चित करेगा कि item_id integer हो और यदि q दिया गया है तो उसे प्रोसेस करेगा।

विभिन्न HTTP मेथड्स संभालना

GET, POST, PUT और DELETE जैसे विभिन्न HTTP मेथड्स लागू करना सरल है और अन्य फ़्रेमवर्क्स में रूट्स परिभाषित करने जैसा ही है। हर मेथड एक विशिष्ट ऑपरेशन प्रकार से जुड़ा है—जैसे डेटा प्राप्त करना (GET), नया डेटा बनाना (POST), मौजूदा डेटा अपडेट करना (PUT), या डेटा हटाना (DELETE)।

GET मेथड

GET मेथड सर्वर से डेटा प्राप्त करने के लिए होता है। FastAPI में आप GET endpoint इस तरह परिभाषित करते हैं:

@app.get("/items/")def get_items():    return {"items": ["Item 1", "Item 2", "Item 3"]}संचालित द्वारा

POST मेथड

POST मेथड नया डेटा बनाने के लिए उपयोग होता है। आप POST endpoint परिभाषित कर अनुरोध बॉडी में डेटा प्राप्त कर सकते हैं:

@app.post("/items/")def create_item(item: dict):    return {"item": item}संचालित द्वारा

PUT मेथड

PUT मेथड मौजूदा डेटा को अपडेट करने के लिए होता है। इसमें आमतौर पर एक पहचानकर्ता और नया डेटा दोनों चाहिए होते हैं:

@app.put("/items/{item_id}")def update_item(item_id: int, item: dict):    return {"item_id": item_id, "updated_item": item}संचालित द्वारा

DELETE मेथड

DELETE मेथड डेटा हटाने के लिए होता है। FastAPI में DELETE endpoint इस प्रकार परिभाषित होता है:

@app.delete("/items/{item_id}")def delete_item(item_id: int):    return {"message": f"Item {item_id} deleted"}संचालित द्वारा

प्रमाणीकरण और सुरक्षा

FastAPI प्रमाणीकरण और सुरक्षा लागू करने के कई साधन देता है:

• HTTP Basic Auth: एक सीधा तरीका, पर सुरक्षा कारणों से सामान्यतः प्रोडक्शन में अनुशंसित नहीं।
• API Keys: क्लाइंट्स के लिए विशिष्ट कुंजियाँ बनाने वाला अधिक सुरक्षित विकल्प।
• OAuth 2.0: प्राधिकरण के लिए जटिल किन्तु मज़बूत मानक, जो थर्ड-पार्टी इंटीग्रेशन्स में आम है।
• JSON Web Tokens (JWT): दो पक्षों के बीच दावों को सुरक्षित रूप से दर्शाने का लोकप्रिय तरीका।