FastAPIのテンプレートプロジェクトがいい感じだった話

1. FastAPIの
テンプレートプロジェクトが
いい感じだった話

2. FastAPI
● PythonのWebフレームワーク

3. 雰囲気
from fastapi import FastAPI
app = FastAPI()
@app.get("/hello")
def hello():
return {"message": "Hello World"}

5. テンプレートの使い方
$ pip install cookiecutter
$ cookiecutter https://github.com/tiangolo/full-stack-fastapi-postgresql
● cookiecutterコマンドで生成

6. cookiecutter
● テンプレートからプロジェクトを生成するPython製コマンドラインツール
○ https://github.com/cookiecutter/cookiecutter
● GitHubで色々公開されている模様
GitHub cookiecutterでリポジトリを検索

7. テンプレートの生成
● 色々聞かれるので答えていく
$ cookiecutter https://github.com/tiangolo/full-stack-fastapi-postgresql
project_name [Base Project]: FastAPI Sample
project_slug [fastapi-sample]:
domain_main [fastapi-sample.com]:
domain_staging [stag.fastapi-sample.com]:
docker_swarm_stack_name_main [fastapi-sample-com]:
docker_swarm_stack_name_staging [stag-fastapi-sample-com]:
secret_key [changethis]:
first_superuser [admin@fastapi_sample.com]:
first_superuser_password [changethis]:

8. 生成されたプロジェクトの構造
● こんな感じのディレクトリ構造になる
project-name/
backend/
app/
app/ ←FastAPIのソースコード
__init__.py
...
frontend/ ←Vueのソースコード
...
scripts/
...

9. 起動
● docker-compose upで立ち上がる
http://localhost/

10. 構成
フロントエンド
コンテナ
nginx
frontend
ソースコード
バックエンド
コンテナ
gunicorn / uvicorn
backend
ソースコード
ワーカー
コンテナ
Celery
worker.py
ソースコード
RabbitMQコンテナ
DBコンテナ
PostgreSQL
ブラウザー
※他にもロードバランサーやCeleryモニター、pgadminがあったが省略
(外部メールサーバー)
Internet

11. 構成
フロントエンド
コンテナ
nginx
frontend
ソースコード
バックエンド
コンテナ
gunicorn / uvicorn
backend
ソースコード
ワーカー
コンテナ
Celery
worker.py
ソースコード
RabbitMQコンテナ
DBコンテナ
PostgreSQL
ブラウザー
※他にもロードバランサーやCeleryモニター、pgadminがあったが省略
(外部メールサーバー)
Internet

12. フロントエンド
● 普通のVueプロジェクトなので省略

13. 構成
フロントエンド
コンテナ
nginx
frontend
ソースコード
バックエンド
コンテナ
gunicorn / uvicorn
backend
ソースコード
ワーカー
コンテナ
Celery
worker.py
ソースコード
RabbitMQコンテナ
DBコンテナ
PostgreSQL
ブラウザー
※他にもロードバランサーやCeleryモニター、pgadminがあったが省略
(外部メールサーバー)
Internet

14. バックエンド
backend/app/app/
api/ APIエンドポイント サンプルアプリはログインやユーザー一覧等
core/ アプリ初期化等
crud/ DBモデルのCRUD
db/ DB初期化等
email-templates/ メールテンプレート
models/ DBモデル(SQLAlchemy)の定義
schemas/ APIのリクエストとレスポンスのデータモデル
utils.py メール送信関数
worker.py ワーカーで実行するタスクの定義
● ディレクトリ構成決めてくれているので助かる

15. バックエンド
● ツール系も揃ってて助かる
○ flake8
○ black
○ isort
○ autoflake
○ mypy
○ Poetry
● 特にmypyが最大限活用できるように構成されていて良い
○ FastAPI
○ pydantic

16. 構成
フロントエンド
コンテナ
nginx
frontend
ソースコード
バックエンド
コンテナ
gunicorn / uvicorn
backend
ソースコード
ワーカー
コンテナ
Celery
worker.py
ソースコード
RabbitMQコンテナ
DBコンテナ
PostgreSQL
ブラウザー
※他にもロードバランサーやCeleryモニター、pgadminがあったが省略
(外部メールサーバー)
Internet

17. ワーカー
● docker-composeでRabbitMQとCeleryのセットアップ済み

18. まとめ
● 欲しい構成ドンピシャのテンプレートがあると捗る
● cookiecutter色々あって楽しそう
● Docker Composeはいいぞ