पायथन में एक एपीआई लिखना (फ्लास्क और रैपिडएपीआई के साथ)

यदि आप इस लेख को पढ़ रहे हैं, तो आप शायद पहले से ही उन संभावनाओं से परिचित हैं जो एपीआई (एप्लिकेशन प्रोग्रामिंग इंटरफ़ेस) का उपयोग करके खुलते हैं।

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

उत्तर सरल है: आपको अपना एपीआई बनाने की आवश्यकता है ।

इस तथ्य के बावजूद कि पहली बार में यह एक चुनौतीपूर्ण काम लगता है, वास्तव में, सब कुछ सरल है। हम आपको दिखाएंगे कि यह पायथन के साथ कैसे किया जाता है।

आरंभ करने के लिए आपको क्या चाहिए

आपको जिस API की आवश्यकता है उसे विकसित करने के लिए:

• अजगर ३
• फ्लास्क - वेब एप्लिकेशन बनाने के लिए एक सरल और उपयोग में आसान ढांचा;
• फ्लास्क-रेस्टफुल फ्लास्क के लिए एक एक्सटेंशन है जो आपको एक आरएएसटी एपीआई को जल्दी और न्यूनतम कॉन्फ़िगरेशन के साथ विकसित करने की अनुमति देता है।

स्थापना कमांड द्वारा की जाती है:

pip install flask-restful 

शुरुआती लोगों के लिए अनुशंसित मुफ्त गहन प्रोग्रामिंग:
टेलीग्राम बॉट विकास C # - अगस्त 26–28 में। नि: शुल्क गहन जो आपको यह समझने की अनुमति देता है कि टेलीग्राम एपीआई और अन्य बारीकियों के साथ काम करने की विशेषताओं में सहायक बॉट कैसे काम करते हैं। तीन सर्वश्रेष्ठ प्रतिभागियों को स्किलबॉक्स से 30,000 रूबल प्राप्त होंगे ।

शुरू करने से पहले

हम बुनियादी CRUID कार्यक्षमता के साथ एक RESTful API विकसित करने जा रहे हैं।

समस्या को पूरी तरह से समझने के लिए, ऊपर वर्णित दो शब्दों को देखें।

REST क्या है?

REST API (रिप्रेजेंटेटिव स्टेट ट्रांसफर) एक API है जो डेटा को एक्सचेंज करने के लिए HTTP रिक्वेस्ट का इस्तेमाल करता है।

बाकी एपीआई कुछ मानदंडों को पूरा करना चाहिए:

• क्लाइंट-सर्वर आर्किटेक्चर: क्लाइंट यूजर इंटरफेस के साथ इंटरैक्ट करता है, और सर्वर बैकएंड और डेटा वेयरहाउस के साथ इंटरैक्ट करता है। क्लाइंट और सर्वर स्वतंत्र हैं, उनमें से किसी को भी दूसरे से अलग किया जा सकता है।
• स्टेटलेस - सर्वर पर कोई क्लाइंट डेटा संग्रहीत नहीं किया जाता है। क्लाइंट स्थिति पर सत्र स्थिति संग्रहीत है।
• Cacheability - ग्राहक समग्र प्रदर्शन को बेहतर बनाने के लिए सर्वर प्रतिक्रियाओं को कैश कर सकते हैं।

एक CRUD क्या है?

CRUD एक प्रोग्रामिंग अवधारणा है जो चार बुनियादी क्रियाओं (बनाने, पढ़ने, अपडेट करने और हटाने) का वर्णन करता है।

REST API में, अनुरोध प्रकार और अनुरोध विधियाँ पोस्ट, पाने, डालने, हटाने जैसी क्रियाओं के लिए ज़िम्मेदार हैं।

अब जब हम मूल शब्द समझ गए हैं, तो आप एपीआई बनाना शुरू कर सकते हैं।

डिज़ाइन

आइए कृत्रिम बुद्धि के बारे में उद्धरणों का एक भंडार बनाएं। एआई आज सबसे तेजी से बढ़ती प्रौद्योगिकियों में से एक है, और पायथन एआई के साथ काम करने के लिए एक लोकप्रिय उपकरण है।

इस एपीआई के साथ, पायथन डेवलपर जल्दी से एआई के बारे में जानकारी प्राप्त कर सकता है और नए विकास से प्रेरित हो सकता है। यदि डेवलपर के पास इस विषय पर मूल्यवान विचार हैं, तो वह उन्हें भंडार में जोड़ने में सक्षम होगा।

आइए आवश्यक मॉड्यूल आयात करके और फ्लास्क को कॉन्फ़िगर करके शुरू करें:

 from flask import Flask from flask_restful import Api, Resource, reqparse import random app = Flask(__name__) api = Api(app) 

इस स्निपेट में, फ्लास्क, एपी, और संसाधन वे कक्षाएं हैं जिनकी हमें आवश्यकता है।

Reqparse एक फ्लास्क-रेस्टफुल अनुरोध पार्सिंग इंटरफ़ेस है ... आपको एक यादृच्छिक उद्धरण प्रदर्शित करने के लिए एक यादृच्छिक मॉड्यूल की भी आवश्यकता होगी।

अब हम एक AI कोट्स रिपॉजिटरी बनाएंगे।

प्रत्येक रेपो प्रविष्टि में शामिल होंगे:

• डिजिटल आईडी
• उद्धरण के लेखक का नाम;
• बोली।

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

 ai_quotes = [ { "id": 0, "author": "Kevin Kelly", "quote": "The business plans of the next 10,000 startups are easy to forecast: " + "Take X and add AI." }, { "id": 1, "author": "Stephen Hawking", "quote": "The development of full artificial intelligence could " + "spell the end of the human race… " + "It would take off on its own, and re-design " + "itself at an ever increasing rate. " + "Humans, who are limited by slow biological evolution, " + "couldn't compete, and would be superseded." }, { "id": 2, "author": "Claude Shannon", "quote": "I visualize a time when we will be to robots what " + "dogs are to humans, " + "and I'm rooting for the machines." }, { "id": 3, "author": "Elon Musk", "quote": "The pace of progress in artificial intelligence " + "(I'm not referring to narrow AI) " + "is incredibly fast. Unless you have direct " + "exposure to groups like Deepmind, " + "you have no idea how fast — it is growing " + "at a pace close to exponential. " + "The risk of something seriously dangerous " + "happening is in the five-year timeframe." + "10 years at most." }, { "id": 4, "author": "Geoffrey Hinton", "quote": "I have always been convinced that the only way " + "to get artificial intelligence to work " + "is to do the computation in a way similar to the human brain. " + "That is the goal I have been pursuing. We are making progress, " + "though we still have lots to learn about " + "how the brain actually works." }, { "id": 5, "author": "Pedro Domingos", "quote": "People worry that computers will " + "get too smart and take over the world, " + "but the real problem is that they're too stupid " + "and they've already taken over the world." }, { "id": 6, "author": "Alan Turing", "quote": "It seems probable that once the machine thinking " + "method had started, it would not take long " + "to outstrip our feeble powers… " + "They would be able to converse " + "with each other to sharpen their wits. " + "At some stage therefore, we should " + "have to expect the machines to take control." }, { "id": 7, "author": "Ray Kurzweil", "quote": "Artificial intelligence will reach " + "human levels by around 2029. " + "Follow that out further to, say, 2045, " + "we will have multiplied the intelligence, " + "the human biological machine intelligence " + "of our civilization a billion-fold." }, { "id": 8, "author": "Sebastian Thrun", "quote": "Nobody phrases it this way, but I think " + "that artificial intelligence " + "is almost a humanities discipline. It's really an attempt " + "to understand human intelligence and human cognition." }, { "id": 9, "author": "Andrew Ng", "quote": "We're making this analogy that AI is the new electricity." + "Electricity transformed industries: agriculture, " + "transportation, communication, manufacturing." } ] 

अब हमें एक संसाधन वर्ग उद्धरण बनाने की आवश्यकता है, जो हमारे एपीआई के समापन बिंदुओं के संचालन को निर्धारित करेगा। कक्षा के अंदर चार विधियां घोषित की जानी चाहिए: प्राप्त करना, पोस्ट करना, हटाना।

चलिए GET विधि से शुरू करते हैं।

यदि आईडी निर्दिष्ट नहीं है, तो अपनी आईडी या एक यादृच्छिक उद्धरण निर्दिष्ट करके एक विशिष्ट उद्धरण प्राप्त करना संभव बनाता है।

 class Quote(Resource): def get(self, id=0): if id == 0: return random.choice(ai_quotes), 200 for quote in ai_quotes: if(quote["id"] == id): return quote, 200 return "Quote not found", 404 

जीईटी विधि एक यादृच्छिक उद्धरण लौटाता है यदि आईडी में डिफ़ॉल्ट मान होता है, अर्थात। विधि को कॉल करते समय, कोई आईडी सेट नहीं किया गया था।

यदि यह निर्दिष्ट किया जाता है, तो विधि उद्धरणों के बीच खोज करती है और एक को ढूंढती है जिसमें निर्दिष्ट आईडी शामिल है। यदि कुछ नहीं मिला है, तो संदेश "404 नहीं पाया गया है" प्रदर्शित होता है।

याद रखें: यदि अनुरोध सफल नहीं है और रिकॉर्ड नहीं मिला तो 404 पर विधि 200 का HTTP स्टेटस लौटाती है।

अब रिपॉजिटरी में एक नया उद्धरण जोड़ने के लिए एक POST विधि बनाते हैं

यह लिखते ही आपको प्रत्येक नए उद्धरण का पहचानकर्ता मिल जाएगा। इसके अलावा, POST अनुरोध बॉडी (लेखक और उद्धरण पाठ) में जाने वाले मापदंडों को पार्स करने के लिए reqparse का उपयोग करेगा।

 def post(self, id): parser = reqparse.RequestParser() parser.add_argument("author") parser.add_argument("quote") params = parser.parse_args() for quote in ai_quotes: if(id == quote["id"]): return f"Quote with id {id} already exists", 400 quote = { "id": int(id), "author": params["author"], "quote": params["quote"] } ai_quotes.append(quote) return quote, 201 

ऊपर दिए गए कोड में, POST विधि ने उद्धरण आईडी स्वीकार कर ली। फिर, रेकपार का उपयोग करते हुए, उन्होंने लेखक और क्वेरी से एक उद्धरण प्राप्त किया, जो उन्हें परम शब्दकोश में संग्रहीत करता है।

यदि निर्दिष्ट आईडी के साथ एक उद्धरण पहले से मौजूद है, तो विधि संबंधित संदेश और कोड 400 प्रदर्शित करती है।

यदि निर्दिष्ट आईडी के साथ एक उद्धरण अभी तक नहीं बनाया गया है, तो विधि निर्दिष्ट आईडी और लेखक के साथ-साथ अन्य मापदंडों के साथ एक नया रिकॉर्ड बनाती है। फिर वह ai_quotes सूची में एक प्रविष्टि जोड़ता है और कोड 201 के साथ एक नई बोली के साथ एक प्रविष्टि देता है।

अब रिपॉजिटरी में मौजूदा उद्धरण को संशोधित करने के लिए एक PUT विधि बनाएं।

 def put(self, id): parser = reqparse.RequestParser() parser.add_argument("author") parser.add_argument("quote") params = parser.parse_args() for quote in ai_quotes: if(id == quote["id"]): quote["author"] = params["author"] quote["quote"] = params["quote"] return quote, 200 quote = { "id": id, "author": params["author"], "quote": params["quote"] } ai_quotes.append(quote) return quote, 201 

PUT पद्धति, पिछले उदाहरण के समान, ID और इनपुट लेती है और पार्क्स reqparse का उपयोग करते हुए मापदंडों का उद्धरण करती है।

यदि निर्दिष्ट आईडी के साथ एक उद्धरण मौजूद है, तो विधि इसे नए मापदंडों के साथ अपडेट करेगी और फिर कोड 200 के साथ एक अद्यतन उद्धरण प्रदर्शित करेगी। यदि निर्दिष्ट आईडी के साथ कोई उद्धरण नहीं है, तो कोड 201 के साथ एक नया रिकॉर्ड बनाया जाएगा।

अंत में, आइए एक उद्धरण हटाने के लिए एक DELETE विधि बनाएं जो अब प्रेरणादायक नहीं है।

 def delete(self, id): global ai_quotes ai_quotes = [qoute for qoute in ai_quotes if qoute["id"] != id] return f"Quote with id {id} is deleted.", 200 

यह विधि आपके द्वारा लिखते समय उद्धरण आईडी प्राप्त करती है और ai_quotes सूची को सामान्य सूची का उपयोग करके अपडेट करती है।

अब जब हमने सभी तरीके बना लिए हैं, तो हमें बस इतना करना है कि संसाधन को एपीआई में जोड़ें, पथ सेट करें और फ्लास्क चलाएं।

 api.add_resource(Quote, "/ai-quotes", "/ai-quotes/", "/ai-quotes/<int:id>") if __name__ == '__main__': app.run(debug=True) 

हमारी REST API सेवा तैयार है!

अगला, हम कमांड का उपयोग करके कंसोल में इसे चलाकर ऐप कोड को फाइल में सेव कर सकते हैं:

 python3 app.py 

अगर सब ठीक है, तो हमें कुछ इस तरह मिलेगा:

* डिबग मोड: पर
* 127.0.0.1 पर चल रहा है: 5000 / (प्रेस CTRL + C छोड़ने के लिए)
* स्टैट के साथ फिर से शुरू करना
* डीबगर सक्रिय है!
* डीबगर पिन: XXXXXXX

परीक्षण एपीआई

एपीआई बनाए जाने के बाद, इसका परीक्षण करने की आवश्यकता है।

यह कर्ल कंसोल यूटिलिटी या इनसोम्निया रेस्ट क्लाइंट का उपयोग करके या रैपिड एपीआई के एपीआई को प्रकाशित करके किया जा सकता है।



हमारे एपीआई प्रकाशित करें

रैपिडएपीआई दुनिया का सबसे बड़ा बाज़ार है जिसमें 10,000 से अधिक एपीआई (और लगभग 1 मिलियन डेवलपर्स) हैं।

रैपिडएपीआई न केवल तीसरे पक्ष के एपीआई के साथ काम करने के लिए एक एकल इंटरफ़ेस प्रदान करता है, बल्कि आपको अपने स्वयं के एपीआई को जल्दी और आसानी से प्रकाशित करने की क्षमता भी देता है।

ऐसा करने के लिए , आपको पहले नेटवर्क पर कुछ सर्वर पर इसे प्रकाशित करना होगा। हमारे मामले में, हम हरोकू का उपयोग करेंगे। उसके साथ काम करने में कोई कठिनाई नहीं होनी चाहिए ( आप यहां उसके बारे में अधिक जान सकते हैं )।

हर्को पर अपना एपीआई कैसे प्रकाशित करें

1. हरोकू को स्थापित करें।

पहला कदम हेरोकू कमांड लाइन इंटरफेस (सीएलआई) को पंजीकृत और स्थापित करना है। यह उबंटू 16+ पर काम करता है।

सुडोकू स्नैप हॉकू -क्लासिक स्थापित करें

फिर लॉग इन करें:

heroku लॉगिन

2. आवश्यक फाइलें जोड़ें।

अब हमें अपने आवेदन में फ़ोल्डर में प्रकाशन के लिए फाइलें जोड़ने की आवश्यकता है:

• आवश्यकताएँ। आवश्यक पायथन मॉड्यूल की एक सूची के साथ;
• Procfile, जो इंगित करता है कि एप्लिकेशन लॉन्च करने के लिए कौन सी कमांड निष्पादित होनी चाहिए;
• .itignore - सर्वर पर आवश्यक फ़ाइलों को बाहर करने के लिए।

आवश्यकताएँ। फ़ाइल में निम्नलिखित पंक्तियाँ होंगी:

• कुप्पी
• कुप्पी के शोकहारा
• gunicorn

कृपया ध्यान दें: हमने सूची में gunicorn (Python WSGI HTTP सर्वर) जोड़ा है, क्योंकि हमें सर्वर पर अपना एप्लिकेशन चलाने की आवश्यकता है।

Procfile में होगा:

वेब: gunicorn ऐप: ऐप

.Gitignore की सामग्री:

 *.pyc __pycache__/ 

अब जब फाइलें बन जाती हैं, तो हम git रेपो और कमिट को इनिशियलाइज़ करते हैं:

 git init git add git commit -m "First API commit" 

3. एक नया हरोकू एप्लिकेशन बनाएं।

 heroku create 

हम मास्टर शाखा को दूरस्थ हरोकू रेपो में भेजते हैं:

 git push heroku master 

अब आप कमांड का उपयोग करके एपीआई सेवा को खोलकर शुरू कर सकते हैं:

 heroku ps:scale web=1 heroku open 

API आपके-random-heroku-name.herokuapp.com/ai-quotes पर उपलब्ध होगा।

रैपिडएपीआई बाज़ार में अपने पायथन एपीआई को कैसे जोड़ें

हरोकू पर एपीआई सेवा प्रकाशित होने के बाद, आप इसे रैपिड एपीआई में जोड़ सकते हैं। यहाँ इस विषय पर विस्तृत प्रलेखन है ।

1. एक RapidAPI खाता बनाएँ।



एक मुफ्त खाता पंजीकृत करें - यह फेसबुक, Google, GitHub का उपयोग करके किया जा सकता है।



2. नियंत्रण कक्ष में एपीआई जोड़ें।



3. इसके बाद, अपने एपीआई के बारे में सामान्य जानकारी दर्ज करें।



4. "ऐड एपीआई" पर क्लिक करने के बाद एक नया पेज दिखाई देता है जहां आप हमारे एपीआई के बारे में जानकारी दर्ज कर सकते हैं।



5. अब आप या तो मैन्युअल रूप से एपीआई एंडपॉइंट दर्ज कर सकते हैं, या ओपनएपीआई का उपयोग करके स्वैगर-फ़ाइल डाउनलोड कर सकते हैं।



खैर, अब हमें एंडपॉइंट पेज पर अपने एपीआई के एंडपॉइंट्स को सेट करना होगा। हमारे मामले में, समापन बिंदु CRUD अवधारणा के अनुरूप हैं (प्राप्त करें, पोस्ट करें, डालें, हटाएं)।



अगला, आपको समापन बिंदु GET AI उद्धरण बनाने की आवश्यकता है, जो एक यादृच्छिक उद्धरण (यदि आईडी डिफ़ॉल्ट है) या निर्दिष्ट आईडी के लिए एक उद्धरण प्रदर्शित करता है।

एक समापन बिंदु बनाने के लिए, "समापन बिंदु बनाएँ" बटन पर क्लिक करें।



अन्य सभी API समापन बिंदुओं के लिए इस प्रक्रिया को दोहराएं। वह सब है! बधाई हो, आपने अपना एपीआई प्रकाशित किया है!

यदि सब कुछ ठीक है, तो एपीआई पेज कुछ इस तरह दिखाई देगा:

निष्कर्ष

इस लेख में, हमने पायथन में अपना स्वयं का RESTful API सेवा बनाने की प्रक्रिया की खोज की, साथ ही Heroku cloud के लिए एपीआई प्रकाशित करने और रैपिडैपि निर्देशिका में इसे जोड़ने की प्रक्रिया की।

लेकिन परीक्षण संस्करण में, एपीआई विकास के केवल मूल सिद्धांतों को दिखाया गया था - सुरक्षा, गलती सहिष्णुता और स्केलेबिलिटी जैसे बारीकियों पर विचार नहीं किया गया था।

असली एपीआई विकसित करते समय, यह सब ध्यान में रखा जाना चाहिए।