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

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

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

उत्तर सरल है: आपको चाहिए अपनी खुद की एपीआई बनाएं.

हालाँकि यह पहली बार में एक कठिन काम लग सकता है, वास्तव में यह काफी सरल है। हम आपको दिखाएंगे कि पायथन के साथ यह कैसे करें।

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

एपीआई विकास के लिए आवश्यक है:

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

इंस्टालेशन कमांड द्वारा किया जाता है:

pip install flask-restful

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

इससे पहले कि आप शुरू करें

हम एक बेसिक के साथ एक RESTful API विकसित करने जा रहे हैं क्रूड कार्यक्षमता.

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

रेस्ट क्या है?

REST API (प्रतिनिधि राज्य स्थानांतरण) एक API है जो डेटा के आदान-प्रदान के लिए HTTP अनुरोधों का उपयोग करता है।

REST API को कुछ मानदंडों को पूरा करना होगा:

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

सीआरयूडी क्या है?

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

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

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

डिज़ाइन

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

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

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

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

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

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

अब हम 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

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

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

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

अब रिपॉजिटरी में एक नया उद्धरण जोड़ने के लिए एक 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 विधि ने एक उद्धरण आईडी स्वीकार की। फिर, reqparse का उपयोग करके, इसने अनुरोध से लेखक और उद्धरण को पुनः प्राप्त किया, और उन्हें पैराम्स डिक्शनरी में संग्रहीत किया।

यदि निर्दिष्ट आईडी वाला उद्धरण पहले से मौजूद है, तो विधि उचित संदेश और कोड 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 विधि, पिछले उदाहरण के समान, एक आईडी और एक इनपुट लेती है और 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 सेवा तैयार है!

इसके बाद, हम कमांड के साथ कंसोल में चलाकर कोड को app.py फ़ाइल में सहेज सकते हैं:

python3 app.py

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

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

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

एपीआई बनने के बाद इसका परीक्षण करना होगा।

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

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

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

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

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

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

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

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

सुडो स्नैप इंस्टाल हेरोकू--क्लासिक

फिर हम लॉग इन करते हैं:

heroku लॉगिन

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

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

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

Requirements.txt फ़ाइल में निम्नलिखित पंक्तियाँ होंगी:

• कुप्पी
• कुप्पी-आरामदायक
• गनिकोर्न

कृपया ध्यान दें कि हमने सूची में गनिकोर्न (पायथन डब्लूएसजीआई HTTP सर्वर) जोड़ा है क्योंकि हमें सर्वर पर अपना एप्लिकेशन चलाने की आवश्यकता है।

प्रोफ़ाइल में शामिल होंगे:

वेब: 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
 

एपीआई यहां उपलब्ध होगी आपका-random-heroku-name.herokuapp.com/ai-quotes.

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

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

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

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

2. कंट्रोल पैनल में एपीआई जोड़ें।

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

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

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

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

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

एंडपॉइंट बनाने के लिए, आपको "एंडपॉइंट बनाएं" बटन पर क्लिक करना होगा।

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

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

निष्कर्ष

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

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

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

स्रोत: www.habr.com