【FastAPI】インストール方法

Python

FastAPIのインストール方法

目次

FastAPIとは

FastAPI は、Pythonの標準である型ヒントに基づいてPython 3.6 以降でAPI を構築するための、モダンで、高速(高パフォーマンス)な、Web フレームワークです。

https://fastapi.tiangolo.com/ja/

準備

Pythonのインストールや仮想環境の準備をしてください。
※ 以下、WindowsのコマンドプロンプトでPyランチャーを使用した場合

>py -3.9 -m venv .venv
>.venv\Scripts\activate.bat

$ python -m pip install -U pip

インストール

$ pip install fastapi "uvicorn[standard]"

実行

以下のようなコードがあるとして

from fastapi import FastAPI


app = FastAPI()

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

@app.get('/items/{id}')
def read_items(id: int, name: str = None):
    return {'id': id, 'name': name}
$ uvicorn main:app --reload
INFO:     Will watch for changes in these directories: ['D:\\_Workspace\\_Apps\\backend']
INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [7824] using WatchFiles
INFO:     Started server process [22228]
INFO:     Waiting for application startup.
INFO:     Application startup complete.

動作確認

http://127.0.0.1:8000/ にアクセスしたら

{"Hello":"World"}

http://127.0.0.1:8000/items/1 にアクセスしたら

{"id":1,"name":null}

http://127.0.0.1:8000/items/1?name=item にアクセスしたら

{"id":1,"name":"item"}

とレスポンスが返ってくるはずです。

また、http://127.0.0.1:8000/docs にアクセスすると以下のようにAPIドキュメントが表示されます。