पाइथनमा API लेख्दै (फ्लास्क र RapidAPI सँग)

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

तपाईको एप्लिकेसनमा धेरै खुल्ला एपीआईहरू मध्ये एउटा थपेर, तपाईले एप्लिकेसनको कार्यक्षमता विस्तार गर्न सक्नुहुन्छ वा आवश्यक डेटाको साथ समृद्ध बनाउन सक्नुहुन्छ। तर के हुन्छ यदि तपाईंले समुदायसँग साझेदारी गर्न चाहनुहुने एउटा अद्वितीय सुविधा विकास गर्नुभयो भने?

जवाफ सरल छ: तपाईंलाई आवश्यक छ तपाईंको आफ्नै API सिर्जना गर्नुहोस्.

यद्यपि यो सुरुमा गाह्रो काम जस्तो लाग्न सक्छ, यो वास्तवमा सरल छ। हामी तपाईंलाई पाइजोन प्रयोग गरेर यो कसरी गर्ने भनेर देखाउनेछौं।

तपाइँ सुरु गर्न के चाहिन्छ

एपीआई विकास गर्न तपाईंलाई आवश्यक छ:

• पाइथन २.७;
• फ्लास्क - वेब अनुप्रयोगहरू सिर्जना गर्नको लागि सरल र प्रयोग गर्न सजिलो फ्रेमवर्क;
• फ्लास्क - आरामदायी फ्लास्कको लागि एक विस्तार हो जसले तपाईंलाई छिटो र न्यूनतम कन्फिगरेसनको साथ REST API विकास गर्न अनुमति दिन्छ।

स्थापना आदेश संग प्रदर्शन गरिएको छ:

pip install flask-restful

हामी शुरुआतीहरूको लागि नि: शुल्क गहन प्रोग्रामिंग पाठ्यक्रम सिफारिस गर्छौं:
C# मा टेलिग्राम बोट विकास — अगस्ट 26-28। एउटा नि:शुल्क गहन पाठ्यक्रम जसले तपाईंलाई सहायक बटहरूले कसरी काम गर्छ, टेलिग्राम एपीआईसँग काम गर्ने विशेषताहरू र अन्य सूक्ष्मताहरू बुझ्न अनुमति दिन्छ। तीन उत्कृष्ट सहभागीहरूले Skillbox बाट 30 rubles प्राप्त गर्नेछन्.

सुरु गर्नु भन्दा पहिले

हामी आधारभूत संग एक RESTful API विकास गर्न जाँदैछौं CRUID कार्यक्षमता.

कार्यलाई पूर्ण रूपमा बुझ्नको लागि, माथि उल्लेखित दुई सर्तहरू बुझौं।

REST भनेको के हो?

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

REST API ले निश्चित मापदण्डहरू पूरा गर्नुपर्छ:

• क्लाइन्ट-सर्भर आर्किटेक्चर: क्लाइन्टले प्रयोगकर्ता इन्टरफेससँग अन्तरक्रिया गर्दछ, र सर्भरले ब्याकइन्ड र डाटा भण्डारणसँग अन्तरक्रिया गर्दछ। ग्राहक र सर्भर स्वतन्त्र छन्, तिनीहरू मध्ये कुनै पनि अर्कोबाट अलग प्रतिस्थापन गर्न सकिन्छ।
• स्टेटलेस - सर्भरमा कुनै क्लाइन्ट डाटा भण्डार गरिएको छैन। सत्र अवस्था ग्राहक पक्षमा भण्डारण गरिएको छ।
• Cacheability - ग्राहकहरूले समग्र प्रदर्शन सुधार गर्न सर्भर प्रतिक्रियाहरू क्यास गर्न सक्छन्।

CRUD भनेको के हो?

RAW एक प्रोग्रामिङ अवधारणा हो जसले चार आधारभूत कार्यहरू (सिर्जना, पढ्न, अद्यावधिक र मेटाउने) वर्णन गर्दछ।

REST API मा, अनुरोध प्रकारहरू र अनुरोध विधिहरू पोस्ट, प्राप्त, पुट, मेटाउने जस्ता कार्यहरूको लागि जिम्मेवार छन्।

अब हामीले आधारभूत सर्तहरू बुझेका छौं, हामी API सिर्जना गर्न सुरु गर्न सक्छौं।

विकास

आर्टिफिसियल इन्टेलिजेन्सको बारेमा उद्धरणहरूको भण्डार सिर्जना गरौं। AI आजको सबैभन्दा छिटो बढिरहेको प्रविधिहरू मध्ये एक हो, र पाइथन AI सँग काम गर्ने लोकप्रिय उपकरण हो।

यस API मार्फत, पाइथन विकासकर्ताले द्रुत रूपमा AI बारे जानकारी प्राप्त गर्न र नयाँ प्रगतिहरूबाट प्रेरित हुन सक्छन्। यदि एक विकासकर्तासँग यस विषयमा बहुमूल्य विचारहरू छन् भने, उसले तिनीहरूलाई भण्डारमा थप्न सक्षम हुनेछ।

आवश्यक मोड्युलहरू आयात गरेर र फ्लास्क सेटअप गरेर सुरु गरौं:

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

यस स्निपेटमा, Flask, Api र Resource हामीलाई चाहिने कक्षाहरू हुन्।

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

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

GET विधिबाट सुरु गरौं

यसले यसको ID निर्दिष्ट गरेर एक विशिष्ट उद्धरण प्राप्त गर्न सम्भव बनाउँछ, वा यदि ID निर्दिष्ट गरिएको छैन भने अनियमित उद्धरण।

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

यदि ID मा पूर्वनिर्धारित मान समावेश छ भने GET विधिले अनियमित उद्धरण फर्काउँछ, अर्थात्। विधि कल गर्दा कुनै आईडी निर्दिष्ट गरिएको थिएन।

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

याद गर्नुहोस्: विधिले अनुरोध सफल भएमा 200 को HTTP स्थिति र रेकर्ड फेला परेन भने 404 फर्काउँछ।

अब भण्डारमा नयाँ उद्धरण थप्नको लागि POST विधि सिर्जना गरौं

तपाईंले टाइप गर्दा प्रत्येक नयाँ उद्धरणको ID प्राप्त हुनेछ। थप रूपमा, 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 विधिले उद्धरण ID स्वीकार गर्यो। त्यसपछि, reqparse प्रयोग गरेर, यसले प्रश्नबाट लेखक र उद्धरण प्राप्त गर्यो, तिनीहरूलाई params शब्दकोशमा भण्डारण गर्यो।

यदि निर्दिष्ट आईडीको साथ उद्धरण पहिले नै अवस्थित छ भने, विधिले सम्बन्धित सन्देश र कोड 400 प्रदर्शन गर्दछ।

यदि निर्दिष्ट ID को साथ उद्धरण अझै सिर्जना गरिएको छैन भने, विधिले निर्दिष्ट ID र लेखक, साथै अन्य प्यारामिटरहरूसँग नयाँ रेकर्ड सिर्जना गर्दछ। त्यसपछि यसले 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 प्रयोग गरेर उद्धरण प्यारामिटरहरू पार्स गर्दछ।

यदि निर्दिष्ट ID भएको उद्धरण अवस्थित छ भने, विधिले यसलाई नयाँ प्यारामिटरहरूसँग अद्यावधिक गर्नेछ र त्यसपछि कोड 200 को साथ अपडेट गरिएको उद्धरण आउटपुट गर्नेछ। यदि निर्दिष्ट ID सँग कुनै उद्धरण छैन भने, कोड 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

यो विधिले इनपुटको रूपमा उद्धरण ID प्राप्त गर्दछ र साझा सूची प्रयोग गरेर 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 क्लाइन्ट प्रयोग गरेर वा Rapid API मा API प्रकाशित गरेर गर्न सकिन्छ।

हाम्रो API प्रकाशित गर्दै

RapidAPI 10 APIs (र लगभग 000 मिलियन विकासकर्ताहरू) को साथ विश्वको सबैभन्दा ठूलो बजार हो।

RapidAPI ले तेस्रो-पक्ष API सँग काम गर्नको लागि एकल इन्टरफेस मात्र प्रदान गर्दैन, तर तपाइँलाई तपाइँको आफ्नै API लाई छिटो र सजिलै प्रकाशित गर्ने क्षमता पनि दिन्छ।

गर्न गर, तपाईंले पहिले यसलाई नेटवर्कमा केही सर्भरमा प्रकाशित गर्न आवश्यक छ। हाम्रो अवस्थामा हामी प्रयोग गर्नेछौं हिरोकू। यसको साथ काम गर्दा कुनै कठिनाइहरू हुनु हुँदैन, (तपाईं यहाँ उनको बारेमा थप पत्ता लगाउन सक्नुहुन्छ).

Heroku मा तपाइँको API कसरी प्रकाशित गर्ने

1. Heroku स्थापना गर्नुहोस्।

पहिलो चरण दर्ता र Heroku कमाण्ड लाइन इन्टरफेस (CLI) स्थापना गर्न छ। यो Ubuntu 16+ मा काम गर्दछ।

sudo snap install heroku — क्लासिक

त्यसपछि लगइन:

heroku लगइन

२. आवश्यक फाइलहरू थप्नुहोस्।

अब हामीले हाम्रो अनुप्रयोगमा फोल्डरमा प्रकाशित गर्न फाइलहरू थप्न आवश्यक छ:

• आवश्यक पाइथन मोड्युलहरूको सूचीको साथ requirements.txt;
• Procfile, जसले एप्लिकेसन चलाउनको लागि कुन कमाण्डहरू कार्यान्वयन गर्नुपर्छ भनेर निर्दिष्ट गर्दछ;
• .gitignore - सर्भरमा आवश्यक नभएका फाइलहरू बहिष्कार गर्न।

Requiments.txt फाइलमा निम्न लाइनहरू हुनेछन्:

• फ्लास्क
• फ्लास्क आरामदायी
• गनीकोर्न

कृपया ध्यान दिनुहोस् कि हामीले सूचीमा gunicorn (Python WSGI HTTP सर्भर) थपेका छौं किनभने हामीले सर्भरमा हाम्रो अनुप्रयोग चलाउन आवश्यक छ।

प्रोफाइल समावेश हुनेछ:

web: gunicorn app:app

.gitignore को सामग्री:

*.pyc
__pycache__/

अब जब फाईलहरू सिर्जना गरिएका छन्, गिट रेपो प्रारम्भ गरौं र प्रतिबद्ध गरौं:

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

3. नयाँ Heroku अनुप्रयोग सिर्जना गर्नुहोस्।

heroku create

हामी मास्टर शाखालाई टाढाको Heroku repo मा धकेल्छौं:

git push heroku master

अब तपाइँ आदेशहरू प्रयोग गरेर API सेवा खोलेर सुरू गर्न सक्नुहुन्छ:

heroku ps:scale web=1
heroku open
 

API मा उपलब्ध हुनेछ your-random-heroku-name.herokuapp.com/ai-quotes.

RapidAPI बजारमा तपाइँको पाइथन API कसरी थप्ने

एक पटक तपाईंको API सेवा Heroku मा प्रकाशित भएपछि, तपाईं यसलाई Rapid API मा थप्न सक्नुहुन्छ। यहाँ विस्तृत दस्तावेज यस बिषयमा।

1. RapidAPI खाता सिर्जना गर्नुहोस्।

नि: शुल्क खाता दर्ता गर्नुहोस् - यो फेसबुक, गुगल, GitHub प्रयोग गरेर गर्न सकिन्छ।

2. नियन्त्रण प्यानलमा API थप्नुहोस्।

3. अर्को, तपाइँको API को बारे मा सामान्य जानकारी प्रविष्ट गर्नुहोस्।

4. "एपीआई थप्नुहोस्" क्लिक गरेपछि एउटा नयाँ पृष्ठ देखा पर्दछ जहाँ तपाइँ हाम्रो एपीआई बारे जानकारी प्रविष्ट गर्न सक्नुहुन्छ।

5. अब तपाइँ या त म्यानुअल रूपमा API एन्डपोइन्टहरू प्रविष्ट गर्न सक्नुहुन्छ वा डाउनलोड गर्न सक्नुहुन्छ swagger-फाइल OpenAPI प्रयोग गर्दै।

ठिक छ, अब हामीले हाम्रो एपीआईको अन्तिम बिन्दुहरू अन्तिम बिन्दु पृष्ठमा सेट गर्न आवश्यक छ। हाम्रो केसमा, अन्त्यबिन्दुहरू CRUD (प्राप्त गर्नुहोस्, पोस्ट गर्नुहोस्, राख्नुहोस्, मेटाउनुहोस्) को अवधारणासँग मेल खान्छ।

अर्को, तपाईंले एउटा GET AI उद्धरण अन्त्य बिन्दु सिर्जना गर्न आवश्यक छ जसले अनियमित उद्धरण (यदि ID पूर्वनिर्धारित छ) वा निर्दिष्ट ID को लागि उद्धरण प्रदर्शन गर्दछ।

अन्तिम बिन्दु सिर्जना गर्न, "अन्तबिन्दु सिर्जना गर्नुहोस्" बटनमा क्लिक गर्नुहोस्।

हामी अन्य सबै API अन्त्य बिन्दुहरूको लागि यो प्रक्रिया दोहोर्याउँछौं। यति नै! बधाई छ, तपाईंले आफ्नो API प्रकाशित गर्नुभएको छ!

यदि सबै ठीक छ भने, API पृष्ठ यस्तो देखिन्छ:

निष्कर्षमा

यस लेखमा, हामीले पाइथनमा तपाईंको आफ्नै RESTful API सेवा सिर्जना गर्ने प्रक्रिया, साथै API लाई Heroku क्लाउडमा प्रकाशित गर्ने र यसलाई RapidAPI डाइरेक्टरीमा थप्ने प्रक्रिया सिक्यौं।

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

वास्तविक API विकास गर्दा, यी सबैलाई ध्यानमा राख्न आवश्यक छ।

स्रोत: www.habr.com