Python で API を作成する (Flask と RapidAPI を使用)

この記事を読んでいる方は、API (アプリケーション プログラミング インターフェイス) を使用することで可能になる可能性についてはすでにご存じかと思います。

多数のパブリック API の XNUMX つをアプリケーションに追加することで、このアプリケーションの機能を拡張したり、必要なデータを追加したりできます。 しかし、コミュニティと共有したい独自の機能を開発した場合はどうなるでしょうか?

答えは簡単です。 独自の API を作成する.

これは最初は困難な作業のように思えるかもしれませんが、実際には非常に簡単です。 Python でこれを行う方法を説明します。

始めるために必要なもの

API 開発には以下が必要です。

• Python3;
• フラスコ — Web アプリケーションを作成するためのシンプルで使いやすいフレームワーク。
• Flask-RESTful は、最小限の構成で REST API を迅速に開発できるようにする Flask の拡張機能です。

インストールは次のコマンドで実行します。

pip install flask-restful

初心者には無料の集中プログラミングをお勧めします。
C# での Telegram ボット開発 — 26月28日からXNUMX日まで。 ヘルパー ボットの仕組み、Telegram API の操作機能、その他のニュアンスを理解できる無料の集中講座です。 上位 30 人の参加者にはスキルボックスから 000 ルーブルが贈られます.

始める前に

基本的な RESTful API を開発します。 CRUID機能.

このタスクを完全に理解するには、上記の XNUMX つの用語を理解しましょう。

レストとは何ですか?

REST API (Representational State Transfer) は、HTTP リクエストを使用してデータを交換する API です。

REST API は特定の基準を満たす必要があります。

• クライアント/サーバー アーキテクチャ: クライアントはユーザー インターフェイスと対話し、サーバーはバックエンドおよびデータ ストアと対話します。 クライアントとサーバーは独立しており、いずれかを他方とは個別に置き換えることができます。
• ステートレス - クライアント データはサーバーに保存されません。 セッション状態はクライアント側に保存されます。
• キャッシュ可能性 - クライアントはサーバーの応答をキャッシュして、全体的なパフォーマンスを向上させることができます。

CRUDとは何ですか?

残酷 は、XNUMX つの基本的なアクション (作成、読み取り、更新、削除) を説明するプログラミングの概念です。

REST API では、リクエスト タイプとリクエスト メソッドが、post、get、put、delete などのアクションを担当します。

基本的な用語を理解したので、API の作成を開始できます。

開発

人工知能に関する名言のリポジトリを作成しましょう。 AI は今日最も急速に成長しているテクノロジーの XNUMX つであり、Python は AI を操作するための人気のあるツールです。

この 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 リクエスト解析インターフェイスです。ランダムな引用符を表示するには、random モジュールも必要です。

次に、AI に関する引用のリポジトリを作成します。

各リポジトリ エントリには次のものが含まれます。

• デジタルID;
• 引用の著者の名前。
• 引用。

これは単なる学習例であるため、すべてのエントリを 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 エンドポイントの操作を定義する Quote リソース クラスを作成する必要があります。 get、post、put、delete の XNUMX つのメソッドをクラス内で宣言する必要があります。

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が設定されていませんでした。

これが設定されている場合、メソッドは引用符内を検索し、指定された ID を含む引用符を見つけます。 何も見つからない場合は、「Quote not found, 404」というメッセージが表示されます。

このメソッドは、リクエストが成功した場合は HTTP ステータス 200 を返し、エントリが見つからなかった場合は 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 ディクショナリに保存します。

指定された ID を持つ引用がすでに存在する場合、メソッドは適切なメッセージとコード 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 に追加し、パスを設定し、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 を押して終了します)
*ステータスを取得して再起動します
* デバッガはアクティブです!
* デバッガ PIN: XXXXXXX

API のテスト

API を作成したら、テストする必要があります。

これは、curl コンソール ユーティリティまたは Insomnia REST クライアントを使用するか、Rapid API で API を公開することによって実行できます。

API を公開する

RapidAPI は、10 を超える API (および約 000 万人の開発者) を擁する世界最大のマーケットプレイスです。

RapidAPI は、サードパーティ API を操作するための単一のインターフェイスを提供するだけでなく、独自の API を迅速かつ簡単に公開することもできます。

へ やれ、まずネットワーク上のサーバーに公開する必要があります。 私たちの場合、使用します ヘロク。 彼と一緒に仕事をするのに何の問題も起こらないはずだ、(ここで詳細を確認できます).

Heroku で API を公開する方法

1. Heroku をインストールします。

最初のステップは、Heraku コマンドライン インターフェイス (CLI) を登録してインストールすることです。 これは Ubuntu 16 以降で動作します。

sudo snap install heroku --classic

次に、ログインします。

Herokuログイン

2. 必要なファイルを追加します。

ここで、公開するファイルをアプリケーション内のフォルダーに追加する必要があります。

• requirements.txt には、必要な Python モジュールのリストが含まれています。
• Procfile: アプリケーションを実行するために実行する必要があるコマンドを指定します。
• .gitignore - サーバー上で不要なファイルを除外します。

requirements.txt ファイルには次の行が含まれます。

• フラスコ
• フラスコの休息
• ガンコーン

アプリケーションをサーバー上で実行する必要があるため、gunicorn (Python WSGI HTTP Server) をリストに追加したことに注意してください。

Procfile には以下が含まれます:

ウェブ：gunicorn app：app

.gitignore の内容:

*.pyc
__pycache__/

ファイルが作成されたので、git リポジトリを初期化してコミットしましょう。

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

3. 新しい Heroku アプリを作成します。

heroku create

master ブランチをリモート 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 アカウントを作成します。

無料のアカウントを登録します。これは Facebook、Google、GitHub を使用して行うことができます。

2. コントロールパネルにAPIを追加します。

3. 次に、API に関する一般情報を入力します。

4. [API を追加] をクリックすると、新しいページが表示され、API に関する情報を入力できます。

5. これで、API エンドポイントを手動で入力するか、ダウンロードできます。 スワガーファイル OpenAPIを使用します。

さて、ここで、「エンドポイント」ページで API のエンドポイントを設定する必要があります。 この場合、エンドポイントは CRUD (取得、投稿、配置、削除) の概念に対応します。

次に、ランダムな見積もり (ID がデフォルトの場合) または指定された ID の見積もりを表示する GET AI Quote エンドポイントを作成する必要があります。

エンドポイントを作成するには、「エンドポイントの作成」ボタンをクリックする必要があります。

他のすべての API エンドポイントに対してこのプロセスを繰り返します。 それで全部です！ おめでとうございます。API が公開されました。

すべてがうまくいけば、API ページは次のようになります。

まとめ

この記事では、Python で独自の RESTful API サービスを作成するプロセスと、API を Heroku クラウドに公開して RapidAPI ディレクトリに追加するプロセスについて説明しました。

しかし、テスト バージョンでは、API 開発の基本原則のみが示されており、セキュリティ、フォールト トレランス、スケーラビリティなどのニュアンスは考慮されていませんでした。

実際の API を開発するときは、これらすべてを考慮する必要があります。

出所： habr.com