כתיבת API ב-Python (עם Flask ו-RapidAPI)

אם אתם קוראים את המאמר הזה, כנראה שאתם כבר מכירים את האפשרויות הנפתחות בעת שימוש ב-API (ממשק תכנות יישומים).

על ידי הוספת אחד מממשקי ה-API הציבוריים הרבים ליישום שלך, אתה יכול להרחיב את הפונקציונליות של יישום זה או להשלים אותו עם הנתונים הדרושים. אבל מה אם פיתחת תכונה ייחודית שאתה רוצה לחלוק עם הקהילה?

התשובה פשוטה: אתה צריך צור API משלך.

למרות שזו עשויה להיראות כמו משימה מרתיעה בהתחלה, היא למעשה די פשוטה. נראה לך איך לעשות את זה עם Python.

מה שאתה צריך כדי להתחיל

פיתוח API דורש:

• פייתון 3;
• בקבוק - מסגרת פשוטה וקלה לשימוש ליצירת יישומי אינטרנט;
• מלא בקבוקים הוא הרחבה עבור Flask המאפשרת לפתח REST API במהירות ובמינימום הגדרה.

ההתקנה מתבצעת על ידי הפקודה:

pip install flask-restful

אנו ממליצים על תכנות אינטנסיבי בחינם למתחילים:
פיתוח בוטים של טלגרם ב-C# - 26-28 באוגוסט. אינטנסיבי חינמי המאפשר לך להבין איך בוטים עוזרים עובדים, את התכונות של עבודה עם ה-API של Telegram ועוד ניואנסים. שלושת המשתתפים המובילים יקבלו 30 רובל מ-Skillbox.

לפני שאתה מתחיל

אנחנו הולכים לפתח RESTful API עם בסיסי פונקציונליות CRUID.

כדי להבין את המשימה במלואה, בואו נבין את שני המונחים שהוזכרו לעיל.

מה זה REST?

REST API (Representational State Transfer) הוא API המשתמש בבקשות HTTP כדי להחליף נתונים.

ממשקי API של REST חייבים לעמוד בקריטריונים מסוימים:

• ארכיטקטורת שרת-לקוח: הלקוח מקיים אינטראקציה עם ממשק המשתמש, והשרת מקיים אינטראקציה עם הקצה האחורי ומאגר הנתונים. הלקוח והשרת הם עצמאיים, כל אחד מהם יכול להיות מוחלף בנפרד מהאחר.
• ללא מצב - אין נתוני לקוח מאוחסנים בשרת. מצב ההפעלה מאוחסן בצד הלקוח.
• יכולת מטמון - לקוחות יכולים לשמור תגובות שרת במטמון כדי לשפר את הביצועים הכוללים.

מה זה CRUD?

הונאה הוא מושג תכנות המתאר ארבע פעולות בסיסיות (יצירה, קריאה, עדכון ומחק).

ב-REST API, סוגי הבקשות ושיטות הבקשות אחראים לפעולות כמו פרסום, קבל, הצב, מחיקה.

כעת, לאחר שעסקנו במונחים הבסיסיים, אנו יכולים להתחיל ליצור את ה-API.

פיתוח

בואו ניצור מאגר של ציטוטים על בינה מלאכותית. בינה מלאכותית היא אחת הטכנולוגיות הצומחות ביותר כיום, ופייתון היא כלי פופולרי לעבודה עם בינה מלאכותית.

עם API זה, מפתח Python יכול ללמוד במהירות על AI ולקבל השראה מהישגים חדשים. אם למפתח יש מחשבות חשובות בנושא זה, הוא יוכל להוסיף אותן למאגר.

נתחיל בייבוא ​​המודולים הנדרשים והגדרת Flask:

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

בקטע זה, Flask, Api ו-Resource הם המחלקות שאנו צריכים.

Reqparse הוא ממשק ניתוח בקשות Flask-RESTful... תצטרך גם את המודול האקראי כדי להציג ציטוט אקראי.

כעת ניצור מאגר של ציטוטים על 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."
    }
]

כעת עלינו ליצור מחלקת משאבים של Quote שתגדיר את הפעולות של נקודות הקצה שלנו ב-API. יש להצהיר על ארבע שיטות בתוך המחלקה: get, post, put, delete.

נתחיל בשיטת 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" מוצגת.

זכור, השיטה מחזירה סטטוס HTTP של 200 אם הבקשה הצליחה ו-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, להגדיר את הנתיב ולהפעיל את Flask.

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 Rapid.

פרסום ה-API שלנו

RapidAPI הוא השוק הגדול בעולם עם למעלה מ-10 ממשקי API (וכמיליון מפתחים).

RapidAPI לא רק מספק ממשק יחיד לעבודה עם ממשקי API של צד שלישי, אלא גם מאפשר לך לפרסם במהירות ובקלות ממשק API משלך.

אל כדי לעשות זאת, תחילה עליך לפרסם אותו בשרת כלשהו ברשת. במקרה שלנו, נשתמש Heroku. העבודה איתו לא אמורה לגרום לקשיים, (תוכל לברר על כך יותר כאן).

כיצד לפרסם את ה-API שלך ב-Heroku

1. התקן את Heroku.

השלב הראשון הוא רישום והתקנת ממשק שורת הפקודה של Heroku (CLI). זה עובד על אובונטו 16+.

sudo snap install heroku --classic

לאחר מכן אנו נכנסים:

התחברות הרוקו

2. הוסף את הקבצים הדרושים.

כעת עלינו להוסיף את הקבצים לפרסום לתיקיה באפליקציה שלנו:

• requirements.txt עם רשימה של מודולי Python נדרשים;
• Procfile, המציין אילו פקודות יש לבצע כדי להפעיל את היישום;
• .gitignore - כדי לא לכלול קבצים שאינם נחוצים בשרת.

קובץ requirements.txt יכיל את השורות הבאות:

• בקבוק
• בקבוק רגוע
• גניקורן

שימו לב שהוספנו את גוניקורן (Python WSGI HTTP Server) לרשימה כי אנחנו צריכים להפעיל את האפליקציה שלנו בשרת.

הפרופיל יכיל:

אינטרנט: אפליקציית גניקורן: אפליקציה

תוכן של ‎.gitignore:

*.pyc
__pycache__/

עכשיו כשהקבצים נוצרו, בואו נאתחל את ה-git repo ונבצע commit:

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

ברגע ששירות ה-API מתפרסם ב-Heroku, אתה יכול להוסיף אותו ל-Rapid API. כאן תיעוד מפורט בנושא זה.

1. צור חשבון RapidAPI.

אנו רושמים חשבון חינמי - ניתן לעשות זאת באמצעות פייסבוק, גוגל, GitHub.

2. הוסף API ללוח הבקרה.

3. לאחר מכן, הזן מידע כללי על ה-API שלך.

4. לאחר לחיצה על "הוסף API" מופיע דף חדש בו ניתן להזין מידע על ה-API שלנו.

5. כעת אתה יכול להזין ידנית את נקודות הקצה של ה-API, או להוריד קובץ swagger באמצעות OpenAPI.

ובכן, כעת עליך להגדיר את נקודות הקצה של ה-API שלנו בדף נקודות הקצה. במקרה שלנו, נקודות הקצה מתאימות למושג CRUD (קבל, פרסם, שים, מחק).

לאחר מכן, עליך ליצור נקודת קצה של GET AI Quote שמציגה ציטוט אקראי (אם המזהה הוא ברירת המחדל) או הצעת מחיר עבור המזהה שצוין.

כדי ליצור נקודת קצה, עליך ללחוץ על כפתור "צור נקודת קצה".

אנו חוזרים על תהליך זה עבור כל שאר נקודות הקצה של ה-API. זה הכל! מזל טוב, פרסמת את ה-API שלך!

אם הכל ילך כשורה, דף ה-API ייראה בערך כך:

מסקנה

במאמר זה עברנו על התהליך של יצירת שירות RESTful API משלנו ב-Python, יחד עם תהליך פרסום ה-API לענן Heroku והוספתו לספריית RapidAPI.

אבל בגרסת הבדיקה הוצגו רק העקרונות הבסיסיים של פיתוח API - ניואנסים כמו אבטחה, סובלנות תקלות ומדרגיות לא נשקלו.

כאשר מפתחים ממשק API אמיתי, יש לקחת את כל זה בחשבון.

מקור: www.habr.com