PythonとFlaskを使用したAPIの作成

Flaskとは

Flaskは、Python用の軽量なウェブアプリケーションフレームワークです。標準で提供する機能を最小限に保っているため、「マイクロフレームワーク」と呼ばれています。

Flaskの特徴

Flaskの特徴は以下の通りです：
– 標準で提供する機能は最小限
– 拡張ライブラリは第三者によって提供
– オブジェクトリレーショナルマッパ
– フォーム値の検証
– ファイルのアップロード
– ユーザーログイン
– 種々のオープンな認証技術等々

FlaskでAPIを作成する

Flaskを使用してREST APIを作成する方法を以下に示します。

必要なライブラリのインストール

まず、Flaskとそれに関連する拡張ライブラリをインストールします。

$ pip install Flask  # 1.1.2
$ pip install Flask-Cors  # 3.0.10
$ pip install python-dotenv  # 0.17.1
$ pip install PyMySql  # 1.0.2
$ pip install Flask-SQLAlchemy  # 2.5.1
$ pip install flask-marshmallow  # 0.14.0
$ pip install marshmallow-sqlalchemy  # 0.25.0

Flaskアプリのファイル構成

Flaskアプリのファイル構成は以下の通りです。

src
├── .env             #環境変数の登録
├── main.py          #アプリ起動
├── router.py        #APIエンドポイントの集約。 ルーター目的
├── db.py            #dbインスタンスの初期化
├── settings.py      #[.env]から環境変数の読込と設定
├── logger.py        #ロギング用のデコレータ
├── auth.py          #APIの実行認可、認証目的
├── controller
│   └── user_controller.py #コントローラー
├── service
│   └── user_service.py #ビジネスロジック
├── model
│   └── users.py         #モデル
├── config
│   ├── logging.json    #ロギングの設定ファイル
│   └── config.py       #DBの各種設定
└── logs
    └── application.log #ログが出力されるファイル

以上がPythonとFlaskを使用してAPIを作成する基本的な手順です。この情報が役立つことを願っています。.