FastAPIとMariaDBをDockerで組み合わせる

投稿者: tanadog 投稿日:

FastAPIとは何か

FastAPIは、Python 3.6以降のバージョンで動作する、非常に高速（StarletteとPydanticによる）なWebフレームワークです。FastAPIは、APIの構築に最適化されており、少ないバグ、短い開発時間、簡単なメンテナンス、そしてより多くの機能を提供します。

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

  • 高速: NodeJSやGoと同等のパフォーマンスを持つ非常に高速なフレームワークです。
  • 高速なコーディング: 約2〜3倍の開発速度を提供します。開発時間を大幅に短縮し、バグを減らします。
  • 少ないバグ: システムが自動的に多くのエラーを防ぐため、バグが80％減少します。
  • 直感的: 素晴らしいエディタのサポートと自動補完機能。開発時間を大幅に短縮し、バグを減らします。
  • 簡単: 高度に直感的で使いやすい設計を目指しています。ドキュメンテーションを読む時間を大幅に短縮します。
  • 短い: コードの重複を最小限に抑えます。各パラメータに複数の機能を持たせます。少ないバグと短い開発時間。
  • 堅牢: プロダクションでの使用を目的として設計されています。そして、それがすでに使用されています。
  • スタンダードベース: APIの定義にOpenAPI（以前はSwagger）とJSON Schemaをベースにしています。
  • 自動的なJSON: リクエストとレスポンスは自動的にJSONに変換されます。
  • 自動的なドキュメンテーション: 完全なユーザーインターフェースとAPIドキュメンテーションが自動的に生成されます。

これらの特徴により、FastAPIは現代のWebアプリケーションやマイクロサービスの開発に非常に適しています。

MariaDBとは何か

MariaDBは、MySQLの開発者であるMichael “Monty” Wideniusが開発したオープンソースのリレーショナルデータベース管理システム（RDBMS）です。MariaDBは、MySQLの代替として設計されており、MySQLとの互換性を保ちつつ、新機能や改善を追加しています。

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

  • MySQLとの互換性: MariaDBは、MySQLとのドロップイン置換として設計されています。つまり、MySQLからMariaDBへの移行は非常に簡単で、ほとんどの場合、そのままの設定で動作します。
  • オープンソース: MariaDBはGPLv2ライセンスの下で公開されています。これにより、誰でも自由に使用、変更、配布することができます。
  • 高性能: MariaDBは、パフォーマンスとスケーラビリティに重点を置いて設計されています。これにより、大規模なデータセットでも高速に動作します。
  • 豊富なストレージエンジン: MariaDBは、InnoDB、MyISAM、Ariaなど、多くのストレージエンジンをサポートしています。これにより、異なる用途に最適なストレージエンジンを選択することができます。
  • セキュリティ: MariaDBは、SSL/TLSによる接続の暗号化、ロールベースのアクセス制御、監査ログなど、多くのセキュリティ機能を提供しています。

これらの特徴により、MariaDBはWebアプリケーションやエンタープライズアプリケーションのデータストレージソリューションとして広く使用されています。また、MariaDBはDockerと組み合わせて使用することで、開発から本番環境までの一貫したデータベース環境を提供することができます。これにより、開発者はアプリケーションの開発に集中することができます。

Dockerを使用する理由

Dockerは、アプリケーションとその依存関係をパッケージ化し、ソフトウェアを一貫して実行するためのオープンソースのプラットフォームです。以下に、Dockerを使用する主な理由をいくつか挙げてみます：

  • 環境の一貫性: Dockerを使用すると、開発環境、テスト環境、本番環境で同じ環境を再現することができます。これにより、「私のマシンでは動作する」という問題を解消します。
  • 依存関係の管理: Dockerはアプリケーションとその依存関係を一緒にパッケージ化します。これにより、アプリケーションが必要とするすべてのソフトウェアが含まれ、正しく動作することが保証されます。
  • 分離とセキュリティ: Dockerは各アプリケーションを分離したコンテナ内で実行します。これにより、アプリケーション間の干渉を防ぎ、セキュリティを向上させます。
  • 移植性: Dockerコンテナはどのマシンでも動作します。これにより、アプリケーションを簡単に移行したり、複数のマシンでスケールアウトしたりすることができます。
  • バージョン管理と共有: Dockerイメージはバージョン管理され、Docker Hubなどのレジストリで簡単に共有することができます。これにより、チーム内での共有やデプロイが容易になります。

これらの理由から、Dockerは開発から本番環境までの一貫した環境を提供し、アプリケーションのデプロイメントとスケーリングを容易にします。FastAPIとMariaDBをDockerで組み合わせることで、開発者はアプリケーションの開発に集中し、環境設定や依存関係の管理から解放されます。これにより、開発者の生産性が向上します。また、Dockerを使用することで、アプリケーションのデプロイメントとスケーリングが容易になります。これは、特にマイクロサービスアーキテクチャやクラウドベースの環境で有用です。このような理由から、Dockerは現代のソフトウェア開発において重要なツールとなっています。

FastAPIとMariaDBのDockerセットアップ

FastAPIとMariaDBをDockerでセットアップするためには、以下の手順を実行します：

  1. Dockerfileの作成: FastAPIアプリケーション用のDockerfileを作成します。このDockerfileでは、Pythonの基本イメージをベースに、必要なパッケージをインストールし、FastAPIアプリケーションをコピーして、適切なコマンドでアプリケーションを起動します。
FROM python:3.8

WORKDIR /app

COPY ./requirements.txt /app/requirements.txt

RUN pip install -r requirements.txt

COPY . /app

CMD ["uvicorn", "main:app", "--host", "0.0.0.0", "--port", "80"]
  1. docker-compose.ymlの作成: docker-composeを使用して、FastAPIとMariaDBのサービスを定義します。このファイルでは、各サービスのDockerfileの場所、ポートのマッピング、ボリュームのマッピング、環境変数などを定義します。
version: '3.7'
services:
  web:
    build: ./app
    command: uvicorn main:app --reload --workers 1 --host 0.0.0.0 --port 8000
    volumes:
      - ./app:/app
    ports:
      - 8000:8000
    depends_on:
      - db
  db:
    image: mariadb:10.4
    restart: always
    environment:
      MYSQL_ROOT_PASSWORD: example
    volumes:
      - ./data/db:/var/lib/mysql
  1. FastAPIとMariaDBの起動: docker-composeを使用して、FastAPIとMariaDBのコンテナを起動します。
docker-compose up

これらの手順により、FastAPIとMariaDBのDockerセットアップが完了します。これにより、開発者は環境設定や依存関係の管理から解放され、アプリケーションの開発に集中することができます。また、Dockerを使用することで、アプリケーションのデプロイメントとスケーリングが容易になります。これは、特にマイクロサービスアーキテクチャやクラウドベースの環境で有用です。このような理由から、Dockerは現代のソフトウェア開発において重要なツールとなっています。このセットアップは、FastAPIとMariaDBを使用したWebアプリケーションの開発の出発点となります。次のステップでは、FastAPIとMariaDBの連携について説明します。それでは、次の小見出しに進みましょう！

FastAPIとMariaDBの連携

FastAPIとMariaDBを連携させるためには、PythonのORM（Object-Relational Mapping）ライブラリであるSQLAlchemyを使用します。SQLAlchemyは、Pythonのクラスとデータベースのテーブルをマッピングし、SQLクエリをPythonコードで表現することができます。

以下に、FastAPIとMariaDBを連携させる基本的な手順を示します：

  1. SQLAlchemyのインストール: SQLAlchemyと、MariaDBとの接続に必要なライブラリをインストールします。
pip install sqlalchemy mysqlclient
  1. データベース接続の設定: SQLAlchemyを使用して、MariaDBへの接続を設定します。この接続設定は、アプリケーションの設定ファイルや環境変数で管理することが一般的です。
from sqlalchemy import create_engine

DATABASE_URL = "mysql+pymysql://user:password@localhost/dbname"

engine = create_engine(DATABASE_URL)
  1. モデルの定義: データベースのテーブルを表すPythonのクラスを定義します。これらのクラスは、SQLAlchemyのBaseクラスを継承します。
from sqlalchemy import Column, Integer, String
from sqlalchemy.ext.declarative import declarative_base

Base = declarative_base()

class User(Base):
    __tablename__ = "users"

    id = Column(Integer, primary_key=True, index=True)
    name = Column(String, unique=True, index=True)
    email = Column(String, unique=True, index=True)
  1. CRUD操作: SQLAlchemyのセッションを使用して、データベースのCRUD（Create, Read, Update, Delete）操作を行います。
from sqlalchemy.orm import Session

# Create
def create_user(db: Session, user: User):
    db.add(user)
    db.commit()
    db.refresh(user)
    return user

# Read
def get_user(db: Session, user_id: int):
    return db.query(User).filter(User.id == user_id).first()

# Update
def update_user(db: Session, user: User):
    db.merge(user)
    db.commit()
    return user

# Delete
def delete_user(db: Session, user_id: int):
    user = db.query(User).filter(User.id == user_id).first()
    db.delete(user)
    db.commit()

これらの手順により、FastAPIとMariaDBの連携が可能になります。これにより、FastAPIを使用してRESTful APIを作成し、MariaDBを使用してデータを永続的に保存することができます。次のステップでは、FastAPIとMariaDBを使用したAPIの作成について説明します。それでは、次の小見出しに進みましょう！

FastAPIとMariaDBを使用したAPIの作成

FastAPIとMariaDBを使用してAPIを作成するためには、以下の手順を実行します：

  1. FastAPIアプリケーションの作成: FastAPIを使用して基本的なWebアプリケーションを作成します。このアプリケーションは、HTTPリクエストを受け取り、適切なレスポンスを返します。
from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def read_root():
    return {"Hello": "World"}
  1. ルートの作成: FastAPIアプリケーションに新しいルートを追加します。このルートは、特定のURLパスに対するHTTPリクエストを処理します。
@app.get("/users/{user_id}")
def read_user(user_id: int):
    return {"user_id": user_id}
  1. データベースとの連携: SQLAlchemyを使用して、FastAPIアプリケーションとMariaDBデータベースを連携します。これにより、APIリクエストに基づいてデータベースのCRUD操作を実行することができます。
from sqlalchemy.orm import Session
from . import models, schemas

def get_user(db: Session, user_id: int):
    return db.query(models.User).filter(models.User.id == user_id).first()

@app.get("/users/{user_id}", response_model=schemas.User)
def read_user(user_id: int, db: Session = Depends(get_db)):
    db_user = get_user(db, user_id=user_id)
    if db_user is None:
        raise HTTPException(status_code=404, detail="User not found")
    return db_user
  1. リクエストとレスポンスのバリデーション: Pydanticを使用して、APIリクエストとレスポンスのバリデーションを行います。これにより、APIが期待する形式とデータ型でリクエストとレスポンスを処理することが保証されます。
from pydantic import BaseModel

class User(BaseModel):
    id: int
    name: str
    email: str

@app.post("/users/", response_model=User)
def create_user(user: User, db: Session = Depends(get_db)):
    db_user = models.User(name=user.name, email=user.email)
    db.add(db_user)
    db.commit()
    db.refresh(db_user)
    return db_user

これらの手順により、FastAPIとMariaDBを使用してAPIを作成することができます。このAPIは、HTTPリクエストを受け取り、データベースの操作を行い、適切なレスポンスを返します。また、FastAPIとMariaDBをDockerで組み合わせることで、開発から本番環境までの一貫した環境を提供します。これにより、開発者はアプリケーションの開発に集中し、環境設定や依存関係の管理から解放されます。それでは、次の小見出しに進みましょう！

結論

FastAPIとMariaDBをDockerで組み合わせることにより、開発者は効率的に、安全に、そしてスケーラブルなWebアプリケーションを開発することができます。FastAPIは、Pythonで高速で使いやすいAPIを作成するためのモダンなフレームワークを提供します。一方、MariaDBは、信頼性とパフォーマンスに優れたオープンソースのデータベースソリューションを提供します。

これらの技術をDockerと組み合わせることで、開発環境と本番環境の間で一貫性を保つことができ、アプリケーションのデプロイメントとスケーリングが容易になります。また、開発者は環境設定や依存関係の管理から解放され、アプリケーションの開発に集中することができます。

この記事では、FastAPIとMariaDBの基本的な概念から、これらの技術をDockerで組み合わせて使用する方法、そしてFastAPIとMariaDBを使用したAPIの作成方法までを説明しました。これらの知識を活用すれば、あなたも高品質なWebアプリケーションを効率的に開発することができるでしょう。それでは、あなたの開発旅行をお楽しみください！

カテゴリー: 未分類

0件のコメント

コメントを残す

アバタープレースホルダー

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

関連投稿

未分類

FastAPIとUvicorn、Gunicornを組み合わせたDockerイメージの作成

FastAPIとは FastAPIは、Pythonの非常に高速な（高性 続きを読む…

未分類

FastAPIで静的ファイルを効率的に扱う方法

FastAPIと静的ファイル FastAPIは、Pythonの非常に高 続きを読む…

未分類

FastAPIとPydanticを用いたブール値モデルの実装

FastAPIとPydanticの概要 FastAPIは、Python 続きを読む…