FastAPIとSQLiteを用いたCRUDアプリケーションの構築

by mr_osson 投稿日:

FastAPIとは

FastAPIは、Pythonの非常に高速な（高性能）、使いやすい、モダンな、高速（高性能）なWebフレームワークです。これは、Python 3.6以降の型ヒントに基づいています。

FastAPIの主な特徴は次のとおりです：

  • 高速: NodeJSやGoと同等の非常に高速なフレームワークです（StarletteとPydanticのおかげです）。
  • 高速なコーディング: 開発者の生産性を約2倍から3倍に向上させます。開発時間を大幅に短縮し、バグを減らし、開発者が直感的に理解できるコードを書くことを可能にします。
  • 少ないバグ: デベロッパーが意図しないエラーやバグを作り出す可能性を減らします。システムがどのように動作するべきかを定義することで、エディタとツールがより多くのエラーを見つけることができます。
  • 直感的: 優れたエディタのサポート。自動補完が非常に効果的です。これにより、必要な時間が大幅に短縮され、開発者が「フロー」状態に入るのが容易になります。
  • 簡単: 高度に直感的で使いやすい設計を目指しています。ドキュメンテーションを読む時間を最小限に抑えることができます。
  • 短い: コードの重複を最小限に抑え、複数の機能を持つ各パラメータを一度だけ宣言します。これにより、バグを減らし、新しい機能を追加するのが容易になります。
  • 堅牢: プロダクションでの使用を目的として設計されています。そして、それが自動的に行われます（Starletteに基づいています）。
  • スタンダードベース: APIの定義には、Web標準に基づいたオープンスタンダードを使用します（OpenAPIとJSON Schema）。データのシリアライゼーションにはPythonの型ヒント（Pydanticに基づいています）を使用します。
  • Pythonic: FastAPIはPythonの型ヒントに深く依存しています。これにより、Pythonのすべての優れた機能を使用することができます。そして、Pythonのすべての優れたエディタのすべての優れた機能を使用することができます。

SQLiteとは

SQLiteは、C言語で書かれた、軽量で高速な組み込み型のリレーショナルデータベースです。SQLiteは、サーバーの設定や管理が不要で、トランザクションをサポートし、SQL92の大部分を実装しています。

SQLiteの主な特徴は次のとおりです：

  • サーバーレス: SQLiteはサーバーレスです。つまり、設定や管理が必要なサーバープロセスはありません。データベースは単一のファイルとしてディスク上に保存されます。
  • トランザクション: SQLiteは完全なACIDトランザクションをサポートしています。これにより、データの整合性が保証されます。
  • 小さなサイズ: SQLiteは非常に小さいサイズで、そのライブラリのサイズは約250KBです（すべての機能を含む場合でも約500KB）。
  • ポータブル: SQLiteデータベースは単一のファイルで、そのファイルは他のシステムに簡単に移動できます。
  • 高速: SQLiteは非常に高速で、多くの一般的なデータベース操作を素早く実行できます。

これらの特性により、SQLiteは組み込みアプリケーション、テスト、プロトタイピング、データ分析など、さまざまな用途に適しています。また、Webアプリケーションのローカルストレージとしてもよく使用されます。しかし、大規模なアプリケーションや高度なデータベース機能が必要な場合には、他のデータベースシステム（例えば、PostgreSQLやMySQL）の使用を検討することが推奨されます。

FastAPIとSQLiteを用いたCRUDアプリケーションの設計

FastAPIとSQLiteを用いてCRUD（Create, Read, Update, Delete）アプリケーションを設計する際の基本的なステップは以下の通りです：

  1. データモデルの定義: まず、SQLiteデータベースに保存するデータの構造を定義します。これは通常、Pythonのクラスを使用して行います。このクラスは、データベースの各行を表すオブジェクトを作成するための「ブループリント」の役割を果たします。

  2. データベース接続の設定: 次に、SQLiteデータベースへの接続を設定します。これには、データベースファイルへのパスと、データベースに接続するためのライブラリ（通常はsqlite3モジュール）が必要です。

  3. APIエンドポイントの定義: FastAPIを使用して、クライアントがデータベースと対話できるようにAPIエンドポイントを定義します。これらのエンドポイントは、データの作成（Create）、読み取り（Read）、更新（Update）、削除（Delete）を行うためのHTTPメソッド（POST、GET、PUT、DELETE）に対応します。

  4. リクエストハンドラの実装: 最後に、各APIエンドポイントに対するリクエストハンドラを実装します。これらのハンドラは、クライアントからのリクエストを受け取り、適切なデータベース操作を実行し、結果をクライアントに返します。

以上が、FastAPIとSQLiteを用いたCRUDアプリケーションの基本的な設計手順です。具体的なコード例や詳細な実装方法については、次のセクションで説明します。この設計手順を理解し、適切に実装することで、効率的でスケーラブルなWebアプリケーションを構築することができます。

データベースの設定

FastAPIとSQLiteを用いたアプリケーションを設計する際には、まずデータベースの設定を行う必要があります。以下に、その基本的な手順を示します。

  1. SQLiteデータベースの作成: SQLiteデータベースは、単一のファイルとしてディスク上に保存されます。データベースを作成するには、Pythonのsqlite3モジュールを使用して新しいデータベースファイルを作成します。
import sqlite3
conn = sqlite3.connect('database.db')

上記のコードは、カレントディレクトリにdatabase.dbという名前の新しいSQLiteデータベースを作成します。

  1. データベース接続の確立: sqlite3.connect()関数は、指定したデータベースファイルへの接続を確立し、その接続を表すConnectionオブジェクトを返します。このConnectionオブジェクトを通じて、データベース操作を行います。

  2. カーソルの作成: データベース操作を行うには、まずCursorオブジェクトを作成する必要があります。Cursorオブジェクトは、データベース内のレコードをトラバースするための「カーソル」を提供します。

cursor = conn.cursor()

以上が、FastAPIとSQLiteを用いたアプリケーションにおけるデータベースの基本的な設定手順です。次のステップでは、このデータベース接続を使用してテーブルを作成し、データを操作するためのAPIエンドポイントを定義します。具体的なコード例や詳細な実装方法については、次のセクションで説明します。この設定手順を理解し、適切に実装することで、効率的でスケーラブルなWebアプリケーションを構築することができます。

テーブル定義

SQLiteデータベースにテーブルを作成するには、SQLのCREATE TABLEステートメントを使用します。以下に、一般的なテーブル定義の例を示します。

cursor.execute('''
    CREATE TABLE IF NOT EXISTS employees(
        id INTEGER PRIMARY KEY,
        name TEXT NOT NULL,
        email TEXT NOT NULL UNIQUE,
        join_date TEXT
    )
''')

上記のコードは、employeesという名前の新しいテーブルを作成します。このテーブルには、id、name、email、join_dateという4つのカラムがあります。

  • id: これは主キー（Primary Key）で、各レコードを一意に識別するためのものです。INTEGER PRIMARY KEYと指定すると、SQLiteはこのカラムを自動的に整数の連番にしてくれます（Auto Increment）。
  • name: これは従業員の名前を保存するためのカラムです。TEXT NOT NULLと指定すると、このカラムはテキスト型で、NULLを許可しないことを意味します。
  • email: これは従業員のメールアドレスを保存するためのカラムです。TEXT NOT NULL UNIQUEと指定すると、このカラムはテキスト型で、NULLを許可せず、また値は一意でなければならないことを意味します。
  • join_date: これは従業員が会社に参加した日付を保存するためのカラムです。型を指定していないため、任意の型の値を保存できます。

以上が、FastAPIとSQLiteを用いたアプリケーションにおけるテーブル定義の基本的な手順です。次のステップでは、このテーブルを使用してデータを操作するためのAPIエンドポイントを定義します。具体的なコード例や詳細な実装方法については、次のセクションで説明します。この設定手順を理解し、適切に実装することで、効率的でスケーラブルなWebアプリケーションを構築することができます。

APIのI/O定義

FastAPIを使用してAPIを設計する際には、各エンドポイントの入力と出力を定義する必要があります。これは、Pythonの型ヒントとPydanticモデルを使用して行います。

以下に、一般的なAPIのI/O定義の例を示します。

from fastapi import FastAPI
from pydantic import BaseModel
from typing import Optional

app = FastAPI()

class Employee(BaseModel):
    name: str
    email: str
    join_date: Optional[str] = None

@app.post("/employees/")
async def create_employee(employee: Employee):
    # データベース操作を行うコードをここに書く
    return {"employee": employee}

上記のコードでは、Employeeという名前の新しいPydanticモデルを定義しています。このモデルは、APIエンドポイントの入力と出力の形式を定義します。Employeeモデルには、name、email、join_dateという3つのフィールドがあります。

  • name: これは従業員の名前を表すフィールドです。型ヒントstrは、このフィールドが文字列であることを示しています。
  • email: これは従業員のメールアドレスを表すフィールドです。型ヒントstrは、このフィールドが文字列であることを示しています。
  • join_date: これは従業員が会社に参加した日付を表すフィールドです。型ヒントOptional[str]は、このフィールドが文字列またはNoneであることを示しています。

そして、create_employeeという名前の新しいAPIエンドポイントを定義しています。このエンドポイントは、POSTリクエストを受け取り、Employeeモデルのインスタンスを入力として受け取ります。

以上が、FastAPIとSQLiteを用いたアプリケーションにおけるAPIのI/O定義の基本的な手順です。次のステップでは、このAPIエンドポイントを使用してデータを操作します。具体的なコード例や詳細な実装方法については、次のセクションで説明します。この設定手順を理解し、適切に実装することで、効率的でスケーラブルなWebアプリケーションを構築することができます。

クエリ発行用の関数定義

SQLiteデータベースに対するクエリを発行するための関数を定義するには、Pythonのsqlite3モジュールを使用します。以下に、一般的なクエリ発行用の関数定義の例を示します。

def create_employee(conn, employee):
    sql = '''
        INSERT INTO employees(name, email, join_date)
        VALUES(?,?,?)
    '''
    cursor = conn.cursor()
    cursor.execute(sql, (employee.name, employee.email, employee.join_date))
    conn.commit()
    return cursor.lastrowid

def get_employee(conn, id):
    sql = 'SELECT * FROM employees WHERE id=?'
    cursor = conn.cursor()
    cursor.execute(sql, (id,))
    return cursor.fetchone()

def get_all_employees(conn):
    sql = 'SELECT * FROM employees'
    cursor = conn.cursor()
    cursor.execute(sql)
    return cursor.fetchall()

def update_employee(conn, id, employee):
    sql = '''
        UPDATE employees
        SET name=?, email=?, join_date=?
        WHERE id=?
    '''
    cursor = conn.cursor()
    cursor.execute(sql, (employee.name, employee.email, employee.join_date, id))
    conn.commit()

def delete_employee(conn, id):
    sql = 'DELETE FROM employees WHERE id=?'
    cursor = conn.cursor()
    cursor.execute(sql, (id,))
    conn.commit()

上記のコードでは、create_employee、get_employee、get_all_employees、update_employee、delete_employeeという5つの関数を定義しています。これらの関数はそれぞれ、データベースに新しい従業員を作成する、特定の従業員を取得する、すべての従業員を取得する、特定の従業員の情報を更新する、特定の従業員を削除するという操作を行います。

以上が、FastAPIとSQLiteを用いたアプリケーションにおけるクエリ発行用の関数定義の基本的な手順です。次のステップでは、これらの関数を使用してAPIエンドポイントを実装します。具体的なコード例や詳細な実装方法については、次のセクションで説明します。この設定手順を理解し、適切に実装することで、効率的でスケーラブルなWebアプリケーションを構築することができます。

APIの実装とテスト

FastAPIとSQLiteを用いたアプリケーションにおけるAPIの実装とテストの基本的な手順は以下の通りです：

  1. APIエンドポイントの実装: まず、先ほど定義したAPIエンドポイントのリクエストハンドラを実装します。これらのハンドラは、クライアントからのリクエストを受け取り、適切なデータベース操作を実行し、結果をクライアントに返します。
@app.post("/employees/")
async def create_employee(employee: Employee):
    with sqlite3.connect('database.db') as conn:
        employee_id = create_employee(conn, employee)
    return {"id": employee_id, "employee": employee}

@app.get("/employees/{id}")
async def read_employee(id: int):
    with sqlite3.connect('database.db') as conn:
        employee = get_employee(conn, id)
    return {"employee": employee}

@app.get("/employees/")
async def read_all_employees():
    with sqlite3.connect('database.db') as conn:
        employees = get_all_employees(conn)
    return {"employees": employees}

@app.put("/employees/{id}")
async def update_employee(id: int, employee: Employee):
    with sqlite3.connect('database.db') as conn:
        update_employee(conn, id, employee)
    return {"id": id, "employee": employee}

@app.delete("/employees/{id}")
async def delete_employee(id: int):
    with sqlite3.connect('database.db') as conn:
        delete_employee(conn, id)
    return {"result": "OK"}
  1. APIのテスト: APIが正しく動作することを確認するために、テストを行います。FastAPIは自動的にAPIのドキュメンテーションとテスト用のUIを生成します。これを使用して、APIの動作を確認できます。

以上が、FastAPIとSQLiteを用いたアプリケーションにおけるAPIの実装とテストの基本的な手順です。具体的なコード例や詳細な実装方法については、次のセクションで説明します。この設定手順を理解し、適切に実装することで、効率的でスケーラブルなWebアプリケーションを構築することができます。

コメントする

メールアドレスが公開されることはありません。 ※ が付いている欄は必須項目です