ホームページ  >  記事  >  バックエンド開発  >  Flaskを使用してRESTful APIを構築する方法

Flaskを使用してRESTful APIを構築する方法

王林
王林オリジナル
2023-06-17 18:31:121012ブラウズ

今日のソフトウェア開発分野では、RESTful API は多くのアプリケーションの中核コンポーネントとなっており、信頼性が高く、分離された、保守が容易なサービスを提供できます。 Flask は、Web アプリケーションと RESTful API を構築する柔軟な方法を提供する軽量の Python Web フレームワークです。この記事では、Flask を使用して RESTful API を構築する方法を紹介します。

  1. Flask のインストール

まず、Python と pip がインストールされていることを確認する必要があります。システム上でターミナルまたはコマンド プロンプトを開き、次のコマンドを入力して Flask をインストールします。

pip install Flask
  1. プロジェクト フォルダーの作成

この例では、という名前のプロジェクト フォルダーを作成します。 「flask-restful」のプロジェクトフォルダーです。ターミナルに次のコマンドを入力してフォルダーを作成します。

mkdir flask-restful
  1. 仮想環境の作成

Flask をグローバルにインストールしないようにするには、仮想環境を使用することをお勧めします。これは、同じコンピュータ上で複数のプロジェクトを開発するのに役立ちます。ターミナルに次のコマンドを入力して、仮想環境を作成します。

python3 -m venv env
  1. 仮想環境をアクティブ化します

ターミナルで仮想環境をアクティブにするには、次のコマンドを入力します。

Mac/Linux の場合:

source env/bin/activate

Windows の場合:

envScriptsctivate
  1. 必要な依存関係を追加する

Flask アプリケーションでは、次のものが必要です。 flask_restful ライブラリとその他のライブラリを使用して、RESTful API リクエストを安全に実行します。これらの依存関係は、仮想環境で pip コマンドを使用してインストールできます。

pip install flask_restful
pip install flask_cors
  1. アプリケーション マスター ファイルの作成

RESTful API を作成する前に、アプリケーションを作成する必要があります。マスターファイル。プロジェクト フォルダーに「app.py」という名前のファイルを作成し、次のコードを追加します。

from flask import Flask
from flask_restful import Api, Resource, reqparse

app = Flask(__name__)
api = Api(app)

users = [
    {
        "name": "Alice",
        "age": 22,
        "occupation": "Software Engineer"
    },
    {
        "name": "Bob",
        "age": 26,
        "occupation": "Data Analyst"
    },
    {
        "name": "Charlie",
        "age": 33,
        "occupation": "UI/UX Designer"
    }
]

class User(Resource):
    def get(self, name):
        for user in users:
            if(name == user["name"]):
                return user, 200
        return "User not found", 404

api.add_resource(User, "/user/<string:name>")

if __name__ == '__main__':
    app.run(debug=True)

上記のコードは、「app」という名前の Flask アプリケーション インスタンスと「api」という名前のインスタンスを作成します。flask_restful オブジェクト。また、ユーザー情報を保存するためのいくつかのデータも定義します。このアプリケーションでは、flask_restful の「Resource」クラスを継承する「User」というクラスも定義します。 User クラスは、get と post という 2 つのメソッドを定義します。指定した名前のユーザー データを取得するために使用される get メソッドのみを実装しました。最後に、User クラスを API の /user/df64b2f2eaba890373bab527a3e6d187 エンドポイントにバインドします。

  1. アプリケーションの実行

ターミナルまたはコマンド プロンプトで、次のコマンドを入力してアプリケーションを起動します:

python app.py

次に、http:/ にアクセスします。 / /localhost:5000/user/Alice (または他のユーザーの名前) がユーザー データを取得できます。

  1. CORS サポートの追加

CORS は、クロスオリジン リソース共有の略です。 RESTful API を使用する場合、開発環境で CORS サポートを使用して、クロスドメイン リソースの問題を回避できます。私たちのアプリケーションでは、flask_cors ライブラリを使用して CORS サポートを追加しました。 CORS サポートを追加するには、次のコードをアプリケーションのメイン ファイルに追加するだけです。

from flask_cors import CORS

app = Flask(__name__)
api = Api(app)
CORS(app)

このコードは、アプリケーション インスタンスと API 定義の後に追加されます。 CORS ミドルウェアをアプリケーション インスタンスにバインドします。

結論

この記事では、Flask を使用して RESTful API を構築する方法を紹介しました。まず Flask をインストールし、プロジェクト フォルダーと仮想環境を作成し、依存関係を追加して、メイン アプリケーション ファイルを作成します。また、クロスオリジンのリソース要求の問題を解決するために CORS サポートを追加する方法も学びました。 Flask を使用して RESTful API サービスを簡単に構築できるようになりました。

以上がFlaskを使用してRESTful APIを構築する方法の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。

声明:
この記事の内容はネチズンが自主的に寄稿したものであり、著作権は原著者に帰属します。このサイトは、それに相当する法的責任を負いません。盗作または侵害の疑いのあるコンテンツを見つけた場合は、admin@php.cn までご連絡ください。