VPSでDockerを使ってPythonとFastAPIでAPI環境構築

2023-04-18

VPS上にDockerを使用してPythonとFastAPIでAPIを作成するための環境構築方法について説明します。この記事では、VPSに初めてログインした状態からDocker環境の構築までの手順を紹介します。また、DockerfileやDocker Composeの設定内容についても説明します。

OSにはUbuntu 22.04を使用しています。

VPSへのログインと初期設定
Dockerのインストール
Dockerfileの作成
Docker Composeファイルの作成
FastAPIプロジェクトの作成
Docker環境でのAPI起動

1. VPSへのログインと初期設定

VPSにSSHでログインし、最初にシステムをアップデートします。

sudo apt-get update
sudo apt-get upgrade

2. Dockerのインストール

以下の手順でDockerをインストールします。

sudo apt-get install ca-certificates curl gnupg
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg
echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu $(. /etc/os-release && echo $VERSION_CODENAME) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
sudo apt-get update
sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin

インストールが完了したら、以下のコマンドでDockerが正しく動作しているか確認します。

sudo docker run hello-world

正しくインストールできていたら次のように表示されるはずです

Hello from Docker!
This message shows that your installation appears to be working correctly.

To generate this message, Docker took the following steps:
 1. The Docker client contacted the Docker daemon.
 2. The Docker daemon pulled the "hello-world" image from the Docker Hub.
    (amd64)
 3. The Docker daemon created a new container from that image which runs the
    executable that produces the output you are currently reading.
 4. The Docker daemon streamed that output to the Docker client, which sent it
    to your terminal.

To try something more ambitious, you can run an Ubuntu container with:
 $ docker run -it ubuntu bash

Share images, automate workflows, and more with a free Docker ID:
 https://hub.docker.com/

For more examples and ideas, visit:
 https://docs.docker.com/get-started/

私が実行した際には途中でエラーが出てしまったのですが、次のコマンドでDockerサービスを再起動したらうまくいきました。

sudo systemctl restart docker.service

3. Dockerfileの作成

プロジェクトディレクトリを作成し、その中にDockerfileを作成します。

mkdir fastapi_project
cd fastapi_project
touch Dockerfile

以下の内容をDockerfileに追加します。

FROM python:3.9-slim-buster

WORKDIR /app

COPY requirements.txt .
RUN pip install --no-cache-dir -r requirements.txt

COPY . .

CMD ["uvicorn", "main:app", "--host", "0.0.0.0", "--port", "80"]

このDockerfileは、Python3.9のイメージをベースに、FastAPIとその依存関係をインストールし、アプリケーションを起動します。

4. Docker Composeファイルの作成

Docker Composeを使ってコンテナを管理するために、docker-compose.ymlファイルを作成します。

touch docker-compose.yml

以下の内容をdocker-compose.ymlに追加します。

version: '3.9'

services:
  fastapi:
    build: .
    ports:
      - "80:80"
    volumes:
      - .:/app
    command: /bin/bash -c "uvicorn main:app --host 0.0.0.0 --port 80 --reload"

このdocker-compose.ymlファイルでは、FastAPIアプリケーションをビルドし、ポート80で公開します。また、ソースコードの変更をリアルタイムで反映させるために、--reloadオプションを付けています。

5. FastAPIプロジェクトの作成

requirements.txtファイルを作成し、以下の内容を追加します。

fastapi
uvicorn

次に、FastAPIアプリケーションのコードを含むmain.pyファイルを作成します。

touch main.py

以下の内容をmain.pyに追加します。

from fastapi import FastAPI

app = FastAPI()

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

これで、ルートパスにアクセスしたときに"Hello World"を返すAPIが完成しました。

6. Docker環境でのAPI起動

Docker Composeを使ってFastAPIアプリケーションを起動します。

sudo docker compose up -d

これで、VPSのポート80でFastAPIアプリケーションが起動しました。ブラウザでhttp://<VPSのIPアドレス>/にアクセスすると、"Hello World"が表示されます。

以上で、VPS上にDockerを使ってPythonとFastAPIでAPI環境構築が完了しました。

まとめ

本記事では、VPS上にDockerを使用してPythonとFastAPIでAPI環境を構築する方法について解説しました。

ディレクトリ構成は以下のようになります。

fastapi_project/
│
├── Dockerfile
├── docker-compose.yml
├── main.py
└── requirements.txt

この構成では、Dockerfileとdocker-compose.ymlがDocker環境の設定を行い、main.pyがFastAPIアプリケーションのコードを格納しています。requirements.txtには、アプリケーションで使用するPythonパッケージのリストが記載されています。

最後に、Docker Composeを使ってFastAPIアプリケーションを起動し、VPSのポート80でAPIが利用可能になりました。これにより、VPS上でDockerを使用してPythonとFastAPIでAPI環境を簡単に構築することができます。

Soraef

ソフトウェアエンジニア。趣味は競馬、写真、ゲーム。

お問い合わせはTwitterのDMでお願いします。