FastAPI入門:小さなAPIを作って動かす手順(Python)

FastAPI入門:小さなAPIを作って動かす手順(Python) FastAPI

こんにちは!ともです。スプレッドシートや他のツールから「データを受け渡しする窓口」が欲しくなる場面があります。画面は要らないけれど、決まった住所(URL)にアクセスしたら決まったデータを返してくれる仕組み、いわゆるAPIです。

この記事では、Pythonのフレームワーク「FastAPI」で、メモのデータを読み取ったり登録したりできる小さなAPIを作ります。FastAPIはAPI作りに特化していて、確認用の画面が自動で用意されるのが入門向きの特徴です。

フレームワーク自体が初めての場合は、先に全体像の記事で考え方を押さえておくと読みやすくなります。

フレームワークとは何か

この記事で分かること

この記事で分かること
この記事で分かること
  • APIとは何か、FastAPIで作るものの完成形
  • 必要なものとコスト
  • FastAPIのインストールと起動の手順
  • データを返す窓口と、登録を受け付ける窓口の作り方
  • 自動で用意される確認画面での動作チェックの方法

完成品のイメージ:住所ごとに決まったデータを返す

完成品のイメージ:住所ごとに決まったデータを返す
完成品のイメージ:住所ごとに決まったデータを返す

完成すると、ブラウザや他のプログラムから住所ごとにアクセスして、メモのデータをやり取りできるようになります。用意する窓口は3つです。一覧を返す窓口、1件を返す窓口、新しいメモの登録を受け付ける窓口です。

データの保存先は、まずはプログラムの中のリスト(仮置き場)にします。データベースとの接続は次の段階の話として切り分け、今回は「APIの形そのもの」を体験することに集中します。

もう1つの完成品が、確認用の画面です。FastAPIは、作った窓口の一覧と試し実行のボタンを備えた画面を自動で用意します。この画面から実際にデータを登録して、結果を目で確かめられます。

必要なものとコスト

必要なものとコスト
必要なものとコスト

FastAPIもPythonも無料で公開されているオープンソースです。自分のパソコンの中で動かす範囲では、料金はかかりません。

項目内容
使うツールPython/FastAPI/venv(Python付属の仕組み)
料金の目安無料(約0円)
前提Pythonの環境構築が済んでいること

バージョンの目安として、FastAPIは2026年11月時点で0.16x系が公開されています(0から始まる番号ですが、実務で広く使われているフレームワークです)。インストール時に付いてくる実行用の道具(サーバー)も含めて、一式で入ります。Python本体の用意がまだの場合は、先に環境構築の記事で土台を整えてください。

Pythonの環境構築の手順

難易度と進め方の目安

難易度と進め方の目安
難易度と進め方の目安

難易度は低めから中くらいです。書くコードは1ファイルに収まり、管理画面つきの大きなフレームワークより部品が少ない分、流れを追いやすくなっています。目安の所要時間は、初期設定込みで1時間前後です。

進め方は「仮想環境の用意→FastAPIの導入→最小の窓口→データの窓口→登録の窓口→確認画面でテスト」の順番です。エディタはVS Codeがあると作業がしやすくなります。

VS Codeのインストールと初期設定

インストール・初期設定

インストール・初期設定
インストール・初期設定

まず、作業用のフォルダで仮想環境を作り、その中にFastAPIを入れます。仮想環境の作り方は、Pythonの環境構築の記事と同じ流れです。

# プロジェクト用のフォルダを作って、その中へ入る
mkdir fastapi-memo && cd fastapi-memo

# 仮想環境を作る(.venv という名前のフォルダができる)
python3 -m venv .venv

# 仮想環境を有効化する(Windowsは .venv\Scripts\Activate.ps1)
source .venv/bin/activate

# FastAPIを一式でインストールする(実行用サーバーなどの関連部品も一緒に入る)
pip install "fastapi[standard]"

# 入ったFastAPIのバージョンを表示して確認する
fastapi --version

次に、最小のプログラムを書いて起動してみます。ファイル名は main.py にします。

# FastAPI本体を読み込む
from fastapi import FastAPI

# アプリの本体を作る(この app が窓口全体の入口になる)
app = FastAPI()


# トップの住所(/)にアクセスが来たら、挨拶のデータを返す
@app.get("/")
def read_root():
    # 返すデータは、Pythonの辞書の形で書く(自動でJSON形式に変換される)
    return {"message": "FastAPIが動いています"}

保存したら、開発用サーバーを起動します。

# 開発用サーバーを起動する(ファイル保存のたびに自動で再読み込みされる)
fastapi dev main.py

ブラウザで http://127.0.0.1:8000/ を開き、挨拶のデータが表示されれば起動は成功です。サーバーは「Ctrl+C」で止められます。

作り方の骨格1:メモを返す窓口を作る

作り方の骨格1:メモを返す窓口を作る
作り方の骨格1:メモを返す窓口を作る

main.py に、メモの仮置き場と、読み取り用の窓口を足していきます。仮置き場は、辞書(項目の集まり)をリストに並べた形にします。

# メモの仮置き場(サーバーを止めると消える、練習用の置き場)
memos = [
    {"id": 1, "title": "買い物メモ", "body": "牛乳と卵"},
    {"id": 2, "title": "会議メモ", "body": "来週の月曜10時から"},
]


# 住所(/memos)にアクセスが来たら、メモの一覧を返す
@app.get("/memos")
def list_memos():
    # 仮置き場の中身をそのまま返す
    return memos


# 住所(/memos/番号)にアクセスが来たら、その番号のメモを返す
@app.get("/memos/{memo_id}")
def get_memo(memo_id: int):
    # 仮置き場から、番号が一致するメモを探す
    for memo in memos:
        if memo["id"] == memo_id:
            # 見つかったメモを返す
            return memo
    # 見つからなかった場合は、その旨のデータを返す
    return {"message": "その番号のメモはありません"}

「{memo_id}」の部分は、住所の中に値を埋め込む書き方です。「memo_id: int」と型を指定しておくと、数字以外の値が来たときに自動でエラーを返してくれます。この「型を指定しておくと、受け付け時にチェックが働く」のがFastAPIの得意なところです。

作り方の骨格2:メモを登録する窓口を作る

作り方の骨格2:メモを登録する窓口を作る
作り方の骨格2:メモを登録する窓口を作る

次に、登録を受け付ける窓口を足します。受け取るデータの形は、「型の設計図」を作って決めます。この設計図に合わないデータが来ると、自動でエラーになります。

# 受け取るデータの形を決めるための土台を読み込む
from pydantic import BaseModel


# 登録時に受け取るデータの設計図(タイトルと本文の2項目)
class MemoIn(BaseModel):
    # タイトル:文字列で受け取る
    title: str
    # 本文:文字列で受け取る
    body: str


# 住所(/memos)への登録リクエストを受け付ける窓口
@app.post("/memos")
def create_memo(memo: MemoIn):
    # 新しい番号を決める(今ある件数+1)
    new_id = len(memos) + 1
    # 受け取った内容に番号を付けて、辞書の形にする
    new_memo = {"id": new_id, "title": memo.title, "body": memo.body}
    # 仮置き場に追加する
    memos.append(new_memo)
    # 登録されたメモをそのまま返す(確認用)
    return new_memo

動作の確認は、自動で用意される画面が便利です。サーバーを起動した状態で http://127.0.0.1:8000/docs を開くと、窓口の一覧が表示されます。「POST /memos」の欄を開いて「Try it out」を押すと、データを入力して実際に登録を試せます。登録後に「GET /memos」で一覧を取り直すと、追加されたメモが見えるはずです。

この確認画面には、設計図(MemoIn)の中身もそのまま表示されます。「どんな形のデータを受け付けるか」が画面で共有できるため、APIを使う側との認識合わせにもそのまま使えます。試しに、タイトルを空にしたデータや、項目が足りないデータを送ってみると、どこが合わなかったかを示すエラーが返ります。この「送る前に形を決めておく→合わなければ理由付きで断られる」という流れが、APIの受け渡しで事故を減らす基本形です。

つまずきやすい点

つまずきやすい点
つまずきやすい点

よくあるつまずきは4つです。1つ目は、仮想環境の有効化忘れです。fastapi のコマンドが「見つからない」と言われたら、画面の先頭に「(.venv)」があるか確認してください。

2つ目は、インストールの書き方です。「fastapi[standard]」の部分は一式入りの指定で、引用符で囲まないとターミナルが別の意味に解釈する場合があります。エラーになったら、引用符付きで打ち直してください。

3つ目は、「サーバーを再起動しないと変更が反映されない」ように見えることです。開発用サーバー(fastapi dev)は保存のたびに自動で読み直しますが、起動の仕方によっては対象外になることもあります。直したのに変わらないときは、一度止めて起動し直すのが確実です。

4つ目は、仮置き場のデータは消えるという点です。サーバーを止めるとリストの中身は初期状態に戻ります。これは仕様どおりの動きで、残したい場合はデータベースとの接続が次の段階になります。

まとめ

まとめ
まとめ

FastAPIの入門は、「インストール→本体の用意→窓口の追加→確認画面でテスト」という流れで進みます。窓口ごとに「住所・受け取る形・返す形」を決めていく作りで、型を指定するとチェックまで自動で付いてくるのが、このフレームワークの進めやすさです。

「画面も管理機能もまとめて付いてくる方がいい」という場合は、同じPythonでも全部入りのフレームワークの作例が向いています。

Django入門:管理画面つきの小さなWebアプリを作る手順

作ったプログラムはGitで記録しておくと、窓口を増やした履歴が残って安心です。

GitのインストールとGitHub連携の手順

なお、「自分で作るのではなく、業務の自動化そのものを相談したい」という場合は、作ってもらう選択肢もあります。

\ 業務の自動化やAI活用を、代わりに作ってほしい方はこちら /

コメント

タイトルとURLをコピーしました