【Docker × FastApi × Poetry】REST APIを実装する~基本~

Copy
.
|-- .vscode
|   |-- launch.json
|   `-- tasks.json
|-- app
|   |-- __init__.py
|   |-- asgi.py
|   |-- endpoints.py
|   `-- main.py
|-- docker-compose.yml
|-- dockerfile
|-- poetry.lock
|-- pyproject.toml
`-- script
    |-- entrypoint.sh
    |-- run_uvicorn.sh
    `-- vscode_ex_install.sh

Copy
# ベースイメージとしてPythonを使用
FROM python:3.12 as python-base

# 作業ディレクトリを作成
WORKDIR /workspace

# pipを更新
RUN pip install --upgrade pip

# Poetryをインストール
RUN pip install poetry

# スクリプトをコピー
COPY script/entrypoint.sh /workspace/script/
# スクリプトを実行するために権限を変更
RUN chmod +x /workspace/script/entrypoint.sh

# エントリーポイントとしてスクリプトを設定
ENTRYPOINT ["/workspace/script/entrypoint.sh"]

Copy
#!/bin/sh

# pyproject.toml が存在するかチェック
if [ ! -f pyproject.toml ]; then
    echo "pyproject.toml が存在しないため、poetry init を実行します..."
    # pyproject.toml が存在しない場合、poetry init を実行
    poetry init -n --name fastapi-restapi --dependency fastapi --dependency uvicorn[standard]
    echo "poetry init が完了しました。"
else
    echo "pyproject.toml が既に存在します。poetry init は実行されませんでした。"
fi

# 依存関係をインストール
echo "依存関係をインストールしています..."
poetry install --no-root
echo "依存関係のインストールが完了しました。"

# # uvicorn サーバーを起動
# echo "仮想環境でuvicorn サーバーを起動しています..."
# sh /workspace/script/run_uvicorn.sh

tail コマンドでコンテナが終了しないようにする
tail -f /dev/null

Copy
#!/bin/sh

poetry run uvicorn app.asgi:app --reload --host 0.0.0.0 --port 8000

Copy
version: "3"
services:
  fastapi:
    container_name: "fastapi"
    build:
      context: .
      dockerfile: Dockerfile
    volumes:
      - .:/workspace
    tty: true
    ports:
      - 8000:8000

Copy
# コンテナ作成実行
docker-compose up -d

# コンテナ作成確認
docker ps
CONTAINER ID   IMAGE                     COMMAND                   CREATED        STATUS         PORTS                    NAMES
8e5ac4313646   faskapi_restapi-fastapi   "/workspace/script/e…"   28 hours ago   Up 9 seconds   0.0.0.0:8000->8000/tcp   fastapi

Copy
$ docker logs fastapi
pyproject.toml が存在しないため、poetry init を実行します...
Using version ^0.114.1 for fastapi
Using version ^0.30.6 for uvicorn
poetry init が完了しました。
依存関係をインストールしています...
Creating virtualenv fastapi-restapi-xS3fZVNL-py3.12 in /root/.cache/pypoetry/virtualenvs
Updating dependencies
Resolving dependencies... (6.5s)

Package operations: 18 installs, 0 updates, 0 removals

  - Installing idna (3.8)
  - Installing sniffio (1.3.1)
  - Installing typing-extensions (4.12.2)
  - Installing annotated-types (0.7.0)
  - Installing anyio (4.4.0)
  - Installing pydantic-core (2.23.3)
  - Installing click (8.1.7)
  - Installing h11 (0.14.0)
  - Installing httptools (0.6.1)
  - Installing pydantic (2.9.1)
  - Installing python-dotenv (1.0.1)
  - Installing pyyaml (6.0.2)
  - Installing starlette (0.38.5)
  - Installing uvloop (0.20.0)
  - Installing watchfiles (0.24.0)
  - Installing websockets (13.0.1)
  - Installing fastapi (0.114.1)                                                                                                    
  - Installing uvicorn (0.30.6)                                                                                                     

Writing lock file
依存関係のインストールが完了しました。
tail: cannot open 'コマンドでコンテナが終了しないようにする' for reading: No such file or directory

Copy
[tool.poetry]
name = "fastapi-restapi"
version = "0.1.0"
description = ""
authors = ["Your Name <you@example.com>"]
readme = "README.md"

[tool.poetry.dependencies]
python = "^3.12"
fastapi = "^0.114.1"
uvicorn = {extras = ["standard"], version = "^0.30.6"}

[build-system]
requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api"

Copy
#!/bin/bash

# 拡張機能のIDリスト
extensions=(
    "ms-python.python"
)

# 各拡張機能をインストール
for extension in "${extensions[@]}"; do
    code --install-extension $extension
done

Copy
@router.get("/test")
async def test():
    return {"message": "Success!"}

Copy
$ curl -i -X GET http://localhost:8000/test
HTTP/1.1 200 OK
date: Sat, 14 Sep 2024 07:58:24 GMT
server: uvicorn
content-length: 22
content-type: application/json

{"message":"Success!"}

Copy
@router.get("/test", status_code=201)
async def test():
    return {"message": "Success!"}

Copy
$ curl -i -X GET http://localhost:8000/test
HTTP/1.1 201 Created
date: Sat, 14 Sep 2024 07:59:56 GMT
server: uvicorn
content-length: 22
content-type: application/json

{"message":"Success!"}

Copy
@router.get("/test", status_code=201)
async def test():
    return Response(status_code=202, content=json.dumps({"message": "Success!"}), media_type="application/json")

Copy
$ curl -i -X GET http://localhost:8000/test
HTTP/1.1 202 Accepted
date: Sat, 14 Sep 2024 08:02:15 GMT
server: uvicorn
content-length: 23
content-type: application/json

{"message":"Success!"}

Copy
@router.get("/test", status_code=201)
async def test():
    users_dict = [
        {"user_id": "1", "name": "Tujimura", "age": 11},
        {"user_id": "2", "name": "mori", "age": 20},
    ]
    return users_dict

Copy
$ curl -i -X GET http://localhost:8000/test
HTTP/1.1 201 Created
date: Sun, 15 Sep 2024 07:07:16 GMT
server: uvicorn
content-length: 83
content-type: application/json

[{"user_id":"1","name":"Tujimura","age":11},{"user_id":"2","name":"mori","age":20}]

Copy
@router.get("/test/{user_id}", status_code=201)
async def test(user_id: int):
    users_dict = [
        {"user_id": 1, "name": "Tujimura", "age": 11},
        {"user_id": 2, "name": "mori", "age": 20},
    ]
    user = next((user for user in users_dict if user['user_id'] == user_id), None)
    return user

Copy
$ curl -i -X GET http://localhost:8000/test/1
HTTP/1.1 201 Created
date: Sun, 15 Sep 2024 07:18:20 GMT
server: uvicorn
content-length: 40
content-type: application/json

{"user_id":1,"name":"Tujimura","age":11}

Copy
$ curl -i -X GET http://localhost:8000/test/abc
HTTP/1.1 422 Unprocessable Entity
date: Sun, 15 Sep 2024 07:19:23 GMT
server: uvicorn
content-length: 152
content-type: application/json

{"detail":[{"type":"int_parsing","loc":["path","user_id"],"msg":"Input should be a valid integer, unable to parse string as an integer","input":"abc"}]}

Copy
@router.get("/test", status_code=201)
async def test(age: int):
    users_dict = [
        {"user_id": 1, "name": "Tujimura", "age": 11},
        {"user_id": 2, "name": "mori", "age": 20},
    ]
    user = next((user for user in users_dict if user['age'] == age), None)
    return user

Copy
$ curl -i -X GET http://localhost:8000/test?age=20
HTTP/1.1 201 Created
date: Sun, 15 Sep 2024 07:32:53 GMT
server: uvicorn
content-length: 36
content-type: application/json

{"user_id":2,"name":"mori","age":20}

Copy
$ curl -i -X GET http://localhost:8000/test?age=abc
HTTP/1.1 422 Unprocessable Entity
date: Sun, 15 Sep 2024 07:33:09 GMT
server: uvicorn
content-length: 149
content-type: application/json

{"detail":[{"type":"int_parsing","loc":["query","age"],"msg":"Input should be a valid integer, unable to parse string as an integer","input":"abc"}]}

Copy
from fastapi import APIRouter, Request
from fastapi.responses import JSONResponse
import copy

router = APIRouter()

# ディクショナリ
users = [
    {"user_id": "1", "name": "Tujimura", "age": 11},
    {"user_id": "2", "name": "mori", "age": 20},
    {"user_id": "3", "name": "shimada", "age": 50},
    {"user_id": "4", "name": "kyogoku", "age": 70}
]

# デフォルト動作検証用のためコメントアウト
# @router.get("/test/{user_id}", response_model=List[dict])
# async def test(user_id: int):
#     users_dict = [
#         {"user_id": 1, "name": "Tujimura", "age": 11},
#         {"user_id": 2, "name": "mori", "age": 20},
#     ]
#     user = next((user for user in users_dict if user['user_id'] == user_id), None)
#     return user

# 参照
# ディクショナリの一覧を取得
@router.get("/")
async def get_users():
    return JSONResponse(status_code=200, content=users)

# 条件指定参照
# ディクショナリの一覧からid指定で取得
@router.get("/{user_id}")
async def get_user_by_id(user_id: str):
    user = next((user for user in users if user['user_id'] == user_id), None)
    if user:
        return JSONResponse(status_code=200, content= user)
    return JSONResponse(status_code=404, content={"error": "User not found"})

# 登録
# ディクショナリに登録
@router.post("/")
async def post_user(request: Request):
    user = await request.json()
    res_users = copy.deepcopy(users)
    res_users.append(user)
    return JSONResponse(status_code=201, content=res_users)

# 更新
# ディクショナリをid指定で更新
@router.put("/{user_id}")
async def put_user(user_id: str, request: Request):
    updated_user = await request.json()
    res_users = copy.deepcopy(users)
    for idx, user in enumerate(res_users):
        if user['user_id'] == user_id:
            res_users[idx] = updated_user
            return JSONResponse(status_code=200, content=res_users)
    return JSONResponse(status_code=404, content={"error": "User not found"})

# 削除
# ディクショナリからid指定で削除
@router.delete("/{user_id}")
async def delete_user(user_id: str):
    res_users = list(filter(lambda user: user['user_id'] != user_id, users))
    return JSONResponse(status_code=200, content=res_users)

Copy
# 参照
# ディクショナリの一覧を取得
@router.get("/")
async def get_users():
    return JSONResponse(status_code=200, content=users)

Copy
from pydantic import BaseModel

# データモデル定義
class Users(BaseModel):
    user_id: str
    name: str
    age: int

# 参照
# ディクショナリの一覧を取得
@router.get("/")
async def get_users():

    # データモデルのインスタンス作成
    invalid_user = Users(user_id="123", name="Add", age=30)

    # インスタンスを戻り値に設定
    return JSONResponse(status_code=200, content=invalid_user)

Copy
from pydantic import BaseModel

# データモデル定義
class Users(BaseModel):
    user_id: str
    name: str
    age: int

# 参照
# ディクショナリの一覧を取得
@router.get("/")
async def get_users():

    # データモデルのインスタンス作成
    invalid_user = Users(user_id="123", name="Add", age=30)

    # インスタンスを辞書形式に変換して戻り値に設定
    return JSONResponse(status_code=200, content=invalid_user.model_dump())

Copy
from fastapi import FastAPI
import app.endpoints as endpoints

def create_app():
    # アプリケーションインスタンスの作成
    app = FastAPI()
    # ルーティング設定
    app.include_router(endpoints.router)

    return app

Copy
from app.main import create_app

app = create_app()

Copy
#!/bin/sh

poetry run uvicorn app.asgi:app --reload --host 0.0.0.0 --port 8000

Copy
poetry run uvicorn app.asgi:app --reload --host 0.0.0.0 --port 8000

Copy
{
    "version": "2.0.0",
    "tasks": [
        {
            "label": "Run Uvicorn with Poetry",
            "type": "shell",
            "command": "./script/run_uvicorn.sh", // 外部スクリプトを指定
            "problemMatcher": [],
            "isBackground": true,
            "group": {
                "kind": "build",
                "isDefault": true
            }
        }
    ]
}

Copy
*  実行するタスク: ./script/run_uvicorn.sh 

INFO:     Will watch for changes in these directories: ['/workspace']
INFO:     Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [876] using WatchFiles
INFO:     Started server process [919]
INFO:     Waiting for application startup.
INFO:     Application startup complete.

Copy
$ curl -i -X GET "http://localhost:8000/" -H "Content-Type: application/json"
HTTP/1.1 200 OK
date: Mon, 16 Sep 2024 07:17:59 GMT
server: uvicorn
content-length: 190
content-type: application/json

[{"user_id": "1", "name": "Tujimura", "age": 11}, {"user_id": "2", "name": "mori", "age": 20}, {"user_id": "3", "name": "shimada", "age": 50}, {"user_id": "4", "name": "kyogoku", "age": 70}]

Copy
$ curl -i -X GET "http://localhost:8000/1" -H "Content-Type: application/json"
HTTP/1.1 200 OK
date: Mon, 16 Sep 2024 07:18:20 GMT
server: uvicorn
content-length: 47
content-type: application/json

{"user_id": "1", "name": "Tujimura", "age": 11}

Copy
$ curl -i -X POST "http://localhost:8000/" -H "Content-Type: application/json" -d '{"user_id": "5", "name": "yamada", "age": 30}'
HTTP/1.1 201 Created
date: Mon, 16 Sep 2024 07:18:38 GMT
server: uvicorn
content-length: 237
content-type: application/json

[{"user_id": "1", "name": "Tujimura", "age": 11}, {"user_id": "2", "name": "mori", "age": 20}, {"user_id": "3", "name": "shimada", "age": 50}, {"user_id": "4", "name": "kyogoku", "age": 70}, {"user_id": "5", "name": "yamada", "age": 30}]

Copy
$ curl -i -X PUT "http://localhost:8000/1" -H "Content-Type: application/json" -d '{"user_id": "1", "name": "Tujimura", "age": 12}'
HTTP/1.1 200 OK
date: Mon, 16 Sep 2024 07:19:06 GMT
server: uvicorn
content-length: 190
content-type: application/json

[{"user_id": "1", "name": "Tujimura", "age": 12}, {"user_id": "2", "name": "mori", "age": 20}, {"user_id": "3", "name": "shimada", "age": 50}, {"user_id": "4", "name": "kyogoku", "age": 70}]

Copy
$ curl -i -X DELETE "http://localhost:8000/1" -H "Content-Type: application/json"
HTTP/1.1 200 OK
date: Mon, 16 Sep 2024 07:19:44 GMT
server: uvicorn
content-length: 141
content-type: application/json

[{"user_id": "2", "name": "mori", "age": 20}, {"user_id": "3", "name": "shimada", "age": 50}, {"user_id": "4", "name": "kyogoku", "age": 70}]

Copy
{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: FastAPI",
            "type": "debugpy",
            "request": "launch",
            "module": "uvicorn",
            "args": [
                "app.asgi:app",
                "--reload",
                "--host",
                "0.0.0.0",
                "--port",
                "8000"
            ],
            "jinja": true,
            "justMyCode": true
        }
    ]
}

Copy
fastapi-restapi-py3.12root@b87372f9e936:/workspace# poetry env list
fastapi-restapi-xS3fZVNL-py3.12 (Activated)

Copy
root@b87372f9e936:/workspace#  cd /workspace ; /usr/bin/env /root/.cache/pypoetry/virtualenvs/fastapi-restapi-xS3fZVNL-py3.12/bin/python /root/.vscode-server/extensions/ms-python.debugpy-2024.10.0-linux-x64/bundled/libs/debugpy/adapter/../../debugpy/launcher 59589 -- -m uvicorn app.asgi:app --reload --host 0.0.0.0 --port 8000 
INFO:     Will watch for changes in these directories: ['/workspace']
ERROR:    [Errno 98] Address already in use
root@b87372f9e936:/workspace#