🥇पायथनमध्ये API लिहिणे (फ्लास्क आणि रॅपिडएपीआय सह)

जर तुम्ही हा लेख वाचत असाल, तर कदाचित तुम्ही API (अॅप्लिकेशन प्रोग्रामिंग इंटरफेस) वापरताना उघडलेल्या शक्यतांशी आधीच परिचित आहात.

तुमच्या ऍप्लिकेशनमध्ये अनेक सार्वजनिक API पैकी एक जोडून, तुम्ही या ऍप्लिकेशनची कार्यक्षमता वाढवू शकता किंवा आवश्यक डेटासह त्यास पूरक करू शकता. परंतु जर तुम्ही एखादे अद्वितीय वैशिष्ट्य विकसित केले असेल जे तुम्हाला समुदायासह सामायिक करायचे असेल तर?

उत्तर सोपे आहे: आपल्याला आवश्यक आहे तुमचे स्वतःचे API तयार करा.

जरी हे सुरुवातीला एक कठीण काम वाटत असले तरी प्रत्यक्षात ते अगदी सोपे आहे. पायथनसह हे कसे करायचे ते आम्ही तुम्हाला दाखवू.

आपल्याला प्रारंभ करण्यासाठी काय आवश्यक आहे

API विकास आवश्यक आहे:

पायथन 3;
फ्लास्क — वेब अनुप्रयोग तयार करण्यासाठी एक साधी आणि वापरण्यास सोपी फ्रेमवर्क;
फ्लास्क-आरामदायक फ्लास्कसाठी एक विस्तार आहे जो तुम्हाला REST API त्वरीत आणि कमीतकमी कॉन्फिगरेशनसह विकसित करण्यास अनुमती देतो.

स्थापना आदेशाद्वारे केली जाते:

pip install flask-restful

आम्ही नवशिक्यांसाठी विनामूल्य गहन प्रोग्रामिंगची शिफारस करतो:
C# मध्ये टेलिग्राम बॉट डेव्हलपमेंट - 26-28 ऑगस्ट. एक विनामूल्य गहन जे तुम्हाला हेल्पर बॉट्स कसे कार्य करतात हे समजून घेण्यास अनुमती देते, टेलीग्राम API सह कार्य करण्याची वैशिष्ट्ये आणि इतर बारकावे. शीर्ष तीन सहभागींना स्किलबॉक्सकडून 30 रूबल मिळतील.

आपण सुरू करण्यापूर्वी

आम्ही बेसिकसह एक RESTful API विकसित करणार आहोत CRUID कार्यक्षमता.

कार्य पूर्णपणे समजून घेण्यासाठी, वर नमूद केलेल्या दोन संज्ञा समजून घेऊ.

REST म्हणजे काय?

REST API (रिप्रेझेंटेशनल स्टेट ट्रान्सफर) एक API आहे जो डेटाची देवाणघेवाण करण्यासाठी HTTP विनंत्या वापरतो.

REST API ने काही निकष पूर्ण केले पाहिजेत:

क्लायंट-सर्व्हर आर्किटेक्चर: क्लायंट वापरकर्ता इंटरफेसशी संवाद साधतो आणि सर्व्हर बॅकएंड आणि डेटा स्टोअरशी संवाद साधतो. क्लायंट आणि सर्व्हर स्वतंत्र आहेत, त्यापैकी कोणतेही दुसर्‍यापासून वेगळे केले जाऊ शकतात.
स्टेटलेस - सर्व्हरवर कोणताही क्लायंट डेटा संग्रहित नाही. सत्र स्थिती क्लायंट बाजूला संग्रहित आहे.
कॅशेबिलिटी - एकूण कार्यप्रदर्शन सुधारण्यासाठी क्लायंट सर्व्हर प्रतिसाद कॅशे करू शकतात.

CRUD म्हणजे काय?

RAW एक प्रोग्रामिंग संकल्पना आहे जी चार मूलभूत क्रियांचे वर्णन करते (तयार करा, वाचा, अद्यतनित करा आणि हटवा).

REST API मध्ये, विनंती प्रकार आणि विनंती पद्धती पोस्ट, गेट, पुट, डिलीट यांसारख्या क्रियांसाठी जबाबदार असतात.

आता आम्ही मूलभूत अटी हाताळल्या आहेत, आम्ही API तयार करणे सुरू करू शकतो.

विकास

आर्टिफिशियल इंटेलिजन्सबद्दलच्या कोट्सचे भांडार तयार करूया. AI हे आज सर्वात वेगाने वाढणाऱ्या तंत्रज्ञानांपैकी एक आहे आणि AI सह काम करण्यासाठी Python हे एक लोकप्रिय साधन आहे.

या API सह, एक पायथन विकसक AI बद्दल त्वरीत शिकू शकतो आणि नवीन यशाने प्रेरित होऊ शकतो. विकसकाचे या विषयावर मौल्यवान विचार असल्यास, तो त्यांना रिपॉझिटरीमध्ये जोडण्यास सक्षम असेल.

चला आवश्यक मॉड्यूल्स आयात करून आणि फ्लास्क सेट करून प्रारंभ करूया:

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

या स्निपेटमध्ये, फ्लास्क, एपीआय आणि रिसोर्स हे आपल्याला आवश्यक असलेले वर्ग आहेत.

Reqparse हा फ्लास्क-रेस्टफुल रिक्वेस्ट पार्सिंग इंटरफेस आहे... यादृच्छिक कोट प्रदर्शित करण्यासाठी तुम्हाला यादृच्छिक मॉड्यूलची देखील आवश्यकता असेल.

आता आपण AI बद्दल कोट्सचे भांडार तयार करू.

प्रत्येक रेपो एंट्रीमध्ये हे समाविष्ट असेल:

डिजिटल आयडी;
कोटच्या लेखकाचे नाव;
कोट

हे फक्त शिकण्याचे उदाहरण असल्याने, आम्ही सर्व नोंदी Python सूचीमध्ये संग्रहित करू. वास्तविक अनुप्रयोगामध्ये, आम्ही बहुधा त्याऐवजी डेटाबेस वापरू.

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."
    }
]

आता आम्हाला कोट रिसोर्स क्लास तयार करणे आवश्यक आहे जे आमच्या API एंडपॉइंट्सच्या ऑपरेशन्स परिभाषित करेल. वर्गात चार पद्धती घोषित केल्या पाहिजेत: मिळवा, पोस्ट करा, पुट करा, हटवा.

चला 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 पद्धत यादृच्छिक कोट परत करते, उदा. कॉल करताना पद्धत आयडी सेट केलेला नव्हता.

जर ते सेट केले असेल, तर पद्धत अवतरणांमध्ये शोधते आणि दिलेला ID असलेला एक शोधते. काहीही न आढळल्यास, "कोट सापडला नाही, 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 वापरून, त्याने लेखक आणि विनंतीचे कोट पुनर्प्राप्त केले, ते params शब्दकोशात संग्रहित केले.

निर्दिष्ट ID सह कोट आधीच अस्तित्वात असल्यास, पद्धत योग्य संदेश आणि कोड 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 सेवा तयार आहे!

पुढे, आम्ही कमांडसह कन्सोलमध्ये चालवून app.py फाइलमध्ये कोड सेव्ह करू शकतो:

python3 app.py

जर सर्व काही ठीक असेल तर आम्हाला असे काहीतरी मिळेल:

* डीबग मोड: चालू
* चालू आहे 127.0.0.1:5000/ (बाहेर पडण्यासाठी CTRL+C दाबा)
* स्टेटसह रीस्टार्ट करत आहे
* डीबगर सक्रिय आहे!
* डीबगर पिन: XXXXXXX

API ची चाचणी करत आहे

API तयार केल्यानंतर, त्याची चाचणी करणे आवश्यक आहे.

हे कर्ल कन्सोल युटिलिटी किंवा Insomnia REST क्लायंट वापरून किंवा रॅपिड API वर API प्रकाशित करून केले जाऊ शकते.

आमचे API प्रकाशित करत आहे

RapidAPI हे 10 APIs (आणि सुमारे 000 दशलक्ष विकसक) असलेले जगातील सर्वात मोठे मार्केटप्लेस आहे.

RapidAPI तृतीय-पक्ष API सह कार्य करण्यासाठी केवळ एकच इंटरफेस प्रदान करत नाही, तर तुम्हाला तुमचे स्वतःचे API जलद आणि सहज प्रकाशित करण्याची अनुमती देते.

करण्यासाठी हे करण्यासाठी, तुम्हाला प्रथम नेटवर्कवरील काही सर्व्हरवर प्रकाशित करणे आवश्यक आहे. आमच्या बाबतीत, आम्ही वापरू हरोकू. त्याच्यासोबत काम केल्याने कोणतीही अडचण येऊ नये, (आपण त्याबद्दल येथे अधिक जाणून घेऊ शकता).

Heroku वर तुमचे API कसे प्रकाशित करावे

1. Heroku स्थापित करा.

पहिली पायरी म्हणजे Heroku Command Line Interface (CLI) नोंदणी करणे आणि स्थापित करणे. हे Ubuntu 16+ वर कार्य करते.

sudo स्नॅप heroku --classic स्थापित करा

मग आम्ही लॉग इन करू:

heroku लॉगिन

2. आवश्यक फाइल्स जोडा.

आता आम्हाला आमच्या अनुप्रयोगातील फोल्डरमध्ये प्रकाशित करण्यासाठी फायली जोडण्याची आवश्यकता आहे:

आवश्यक पायथन मॉड्यूल्सच्या सूचीसह requirements.txt;
Procfile, जे अनुप्रयोग चालविण्यासाठी कोणत्या आज्ञा कार्यान्वित केल्या पाहिजेत हे निर्दिष्ट करते;
.gitignore - सर्व्हरवर आवश्यक नसलेल्या फाइल्स वगळण्यासाठी.

Requiments.txt फाइलमध्ये खालील ओळी असतील:

फ्लास्क
फ्लास्क-आरामदायक
गनिकॉर्न

कृपया लक्षात घ्या की आम्ही गनिकॉर्न (पायथन WSGI HTTP सर्व्हर) सूचीमध्ये जोडले आहे कारण आम्हाला आमचा अनुप्रयोग सर्व्हरवर चालवायचा आहे.

प्रोफाइलमध्ये हे समाविष्ट असेल:

web: gunicorn app:app

.gitignore ची सामग्री:

*.pyc
__pycache__/

आता फाइल्स तयार झाल्या आहेत, चला git repo सुरू करू आणि कमिट करू:

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

3. नवीन Heroku अॅप तयार करा.

heroku create

मास्टर ब्रँचला रिमोट Heroku रेपोवर ढकलणे:

git push heroku master

आता तुम्ही कमांडसह API सेवा उघडून प्रारंभ करू शकता:

heroku ps:scale web=1
heroku open

API येथे उपलब्ध असेल your-random-heroku-name.herokuapp.com/ai-quotes.

तुमचा Python API RapidAPI मार्केटप्लेसमध्ये कसा जोडायचा

Heroku वर API सेवा प्रकाशित झाल्यानंतर, तुम्ही ती रॅपिड API मध्ये जोडू शकता. येथे तपशीलवार दस्तऐवजीकरण या विषयावर.

1. RapidAPI खाते तयार करा.

आम्ही एक विनामूल्य खाते नोंदणी करतो - हे Facebook, Google, GitHub वापरून केले जाऊ शकते.

2. नियंत्रण पॅनेलमध्ये API जोडा.

3. पुढे, तुमच्या API बद्दल सामान्य माहिती प्रविष्ट करा.

4. “Add API” वर क्लिक केल्यानंतर एक नवीन पृष्ठ दिसेल जिथे तुम्ही आमच्या API बद्दल माहिती प्रविष्ट करू शकता.

5. आता तुम्ही API एंडपॉइंट्स व्यक्तिचलितपणे प्रविष्ट करू शकता किंवा डाउनलोड करू शकता swagger फाइल OpenAPI वापरून.

बरं, आता तुम्हाला आमच्या API चे एंडपॉइंट्स एंडपॉइंट्स पेजवर सेट करावे लागतील. आमच्या बाबतीत, अंतिम बिंदू CRUD च्या संकल्पनेशी संबंधित आहेत (मिळवा, पोस्ट करा, ठेवा, हटवा).

पुढे, तुम्हाला GET AI कोट एंडपॉइंट तयार करणे आवश्यक आहे जे यादृच्छिक कोट (आयडी डीफॉल्ट असल्यास) किंवा निर्दिष्ट आयडीसाठी कोट प्रदर्शित करते.

एंडपॉइंट तयार करण्यासाठी, तुम्हाला "एंडपॉइंट तयार करा" बटणावर क्लिक करणे आवश्यक आहे.

आम्ही इतर सर्व API एंडपॉइंटसाठी ही प्रक्रिया पुन्हा करतो. इतकंच! अभिनंदन, तुम्ही तुमचे API प्रकाशित केले आहे!

सर्व काही ठीक असल्यास, API पृष्ठ असे काहीतरी दिसेल:

निष्कर्ष

या लेखात, आम्ही पायथनमध्ये आमची स्वतःची RESTful API सेवा तयार करण्याच्या प्रक्रियेसह, Heroku क्लाउडवर API प्रकाशित करण्याच्या आणि RapidAPI निर्देशिकेत जोडण्याच्या प्रक्रियेतून गेलो.

परंतु चाचणी आवृत्तीमध्ये, API विकासाची केवळ मूलभूत तत्त्वे दर्शविली गेली - सुरक्षा, दोष सहिष्णुता आणि स्केलेबिलिटी यासारख्या बारकावे विचारात घेतल्या गेल्या नाहीत.

वास्तविक API विकसित करताना, हे सर्व विचारात घेतले पाहिजे.

स्त्रोत: www.habr.com

पायथनमध्ये एपीआय लिहिणे (फ्लास्क आणि रॅपिडएपीआयसह)

आपल्याला प्रारंभ करण्यासाठी काय आवश्यक आहे

विकास

निष्कर्ष

एक टिप्पणी जोडा Отменить ответ