fastAPIの環境構築方法。

概要

Web アプリケーション開発のための Python フレームワーク「fastAPI」を使用するには、以下の手順を行う必要があります。

version 確認 

python: v3.11.2
fastapi: v0.45.0
uvicorn: v0.21.0

Python のインストール

まず、Python をインストールする必要があります。Python のバージョンは、3.6 以降が必要です。

Python がインストールされているかどうかを確認するには、ターミナルまたはコマンドプロンプトで以下のコマンドを実行します。

python --version

バージョン情報が表示されたら、Python がインストールされています。 FastAPI は Python バージョンが 3.6 以上でないと動作しません。

fastAPI のインストール

fastAPI をインストールするには、以下のコマンドを実行します。

pip install fastapi

uvicorn のインストール

fastAPI を実行するためには、ASGI サーバーが必要です。ASGI サーバーの中でも特に軽量な「uvicorn」を使用することができます。

以下のコマンドを実行して、uvicorn をインストールします。

pip install uvicorn

fastAPI の実行

fastAPI を実行するには、以下の手順を行います。

  1. fastAPI のコードを作成する
  2. uvicorn コマンドを使用して、fastAPI を実行する
from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def read_root():
    return {"Hello": "World"}

このコードは、"/“にアクセスすると「{“Hello”: “World”}」という JSON を返す簡単な fastAPI のコードです。

このコードを main.py という名前で保存します。

次に、以下のコマンドを実行して、uvicorn を使用して fastAPI を実行します。

uvicorn main:app --reload

上記のコマンドでは、main は Python ファイルの名前、app は FastAPI オブジェクトの名前です。–reload オプションを指定すると、コードが変更されたときに自動的に再読み込みされます。

ブラウザで http://localhost:8000/ にアクセスすると、「{“Hello”: “World”}」という JSON が表示されます。

以上が、fastAPI の環境構築方法です。

管理しやすいプロジェクト構成(おまけ)

FastAPI 環境を他メンバーに共有するとき、 このままでは不便ですので npm scripts を記述して、より簡潔にします。

  • 補足 npm scripts を使用するためには、node.js をインストールしてください

バージョン管理のために requipments を作成する

// requipments.txt
fastapi >= 0.45.0
uvicorn >= 0.17.0

// package.json
{
  "name": "fastapi_setup",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "install": "pip install -r requirements.txt",
    "start": "uvicorn main:app --reload"
  },
  "author": "",
  "license": "ISC"
}

以下ファイルを作成したら、npm scripts を使用して pyinstaller と openpyxl をインストールします。


npm run install

インストールが完了したら、npm scripts を使用し、fast API を実行します。


npm run start

ブラウザで http://localhost:8000/ にアクセスすると、「{“Hello”: “World”}」という JSON が表示されます。

プロジェクトについては以下に挙げておくので参照してみてください https://github.com/wiblok/python/tree/main/fastAPI_setup

← openpyxlでExcelを操作する