【Docker × Flask】コンテナでFlask製のREST APIを実装する~基本~

Copy
from flask import Flask

# flaskアプリケーションインスタンス作成
flask_api = Flask(__name__)

@flask_api.route('/')
def hello():
    return "Hello from Flask!!!"

Copy
from flask import Flask
from flask.views import MethodView

# flaskアプリケーションインスタンス作成
flask_api = Flask(__name__)

class HelloAPI(MethodView):
    def get(self):
        return "Hello from Flask!!!"

flask_api.add_url_rule('/', view_func=HelloAPI.as_view('hello_api'))

Copy
|-- .env
|-- .vscode
|   |-- launch.json
|   `-- tasks.json
|-- Dockerfile
|-- api
|   |-- __init__.py
|   |-- api.py
|   `-- wsgi.py
|-- docker-compose.yml
|-- requirements.txt
`-- vscode_ex_install.sh

Copy
FLASK_APP=api.wsgi:api # Flaskがどのアプリケーションを実行するか指定(パッケージ.モジュール:flaskインスタンス)
FLASK_ENV=development # Flaskがどの環境で動作するか指定
FLASK_DEBUG=true #デバッグモードの指定
# PYTHONPATH=/workspace/api #Pythonがモジュールを検索するためのパスを指定

Copy
FROM python:3.12

# workspaceディレクトリ作成、移動
WORKDIR /workspace

# プロジェクトディレクトリにコピー
COPY requirements.txt /workspace

# 必要モジュールのインストール
RUN pip install --upgrade pip
RUN pip install -r requirements.txt

Copy
version: "3"
services:
  sample-api:
    container_name: "sample-api"
    build:
      context: .
      dockerfile: Dockerfile

    ports:
      - "5000:5000"
    volumes:
      # バインドマウント
      - .:/workspace
    # 環境変数読み込み
    env_file:
      - .env
    tty: true

Copy
Flask==3.0.2

Copy
$ docker compose up -d
$ docker ps
CONTAINER ID   IMAGE                             COMMAND     CREATED              STATUS              PORTS                    NAMES
c9050742de6a   flask-sample-restapi-sample-api   "python3"   About a minute ago   Up About a minute   0.0.0.0:5000->5000/tcp   sample-api

Copy
#!/bin/bash

# 拡張機能のIDリスト
extensions=(
    "ms-python.python"
    "ms-python.vscode-pylance"
    "ms-python.debugpy"
    "mhutchie.git-graph"
)

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

Copy
# flaskインスタンス生成関数をimport
from api.api import create_app

# flaskインスタンスを生成
api = create_app()

Copy
from flask import Flask, request, jsonify
from flask.views import MethodView
import copy

# ディクショナリ
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}]

# 関数ベースのルーティング関数
def routers(api):
    # 取得
    # HTTPリクエストにクエリパラメータあり
    # 全件取得 or ageフィルタリング
    @api.route('/functionalBase', methods=['GET'])
    def get_users():
        # GETリクエストを処理
        age = request.args.get('age')
        if age:
            return jsonify(list(filter(lambda user: user['age'] == int(age), users)))
        return jsonify(users)

    # 登録
    # HTTPリクエストからJSONを受け取る
    # JSONデータを新規登録
    @api.route('/functionalBase', methods=['POST'])
    def post_user():
        # POSTリクエストを処理
        data = request.get_json()
        res_users = copy.deepcopy(users)
        res_users.append(data)
        return jsonify(res_users), 201

    # 更新
    # HTTPリクエストにパスパラメータあり
    # パスパラメータをkeyにしてJSONデータで更新
    @api.route('/functionalBase/<user_id>', methods=['PUT'])
    def put_user(user_id):
        # PUTリクエストを処理
        data = request.get_json()
        res_users = copy.deepcopy(users)
        res_users = list(map(lambda user: user.update(data) or user if user['user_id'] == user_id else user, res_users))
        return jsonify(res_users)

    # 削除
    # HTTPリクエストにパスパラメータあり
    # パスパラメータをkeyにして削除
    @api.route('/functionalBase/<user_id>', methods=['DELETE'])
    def delete_user(user_id):
        # DELETEリクエストを処理
        res_users = list(filter(lambda user: user['user_id'] != user_id, users))
        return jsonify(res_users)

# クラスベースのルーティング
class UserAPI(MethodView):
    # 取得
    # HTTPリクエストにクエリパラメータあり
    # 全件取得 or ageフィルタリング
    def get(self):
        age = request.args.get('age')
        if age:
            return jsonify(list(filter(lambda user: user['age'] == int(age), users)))
        return jsonify(users)

    # 登録
    # HTTPリクエストからJSONを受け取る
    # JSONデータを新規登録
    def post(self):
        data = request.get_json()
        res_users = copy.deepcopy(users)
        res_users.append(data)
        return jsonify(res_users), 201

    # 更新
    # HTTPリクエストにパスパラメータあり
    # パスパラメータをkeyにしてJSONデータで更新
    def put(self, user_id):
        data = request.get_json()
        res_users = copy.deepcopy(users)
        res_users = list(map(lambda user: user.update(data) or user if user['user_id'] == user_id else user, res_users))
        return jsonify(res_users)

    # 削除
    # HTTPリクエストにパスパラメータあり
    # パスパラメータをkeyにして削除
    def delete(self, user_id):
        res_users = list(filter(lambda user: user['user_id'] != user_id, users))
        return jsonify(res_users)

# flaskインスタンス作成
def create_app():
    # 作成
    api = Flask(__name__)

    # 関数ベースのルーティング設定
    routers(api)

    # クラスベースのビューを関数ベースのビューに変換
    user_view = UserAPI.as_view('user_api')

    # エンドポイントを設定
    api.add_url_rule('/classBase', view_func=user_view, methods=['GET',])
    api.add_url_rule('/classBase', view_func=user_view, methods=['POST',])
    api.add_url_rule('/classBase/<string:user_id>', view_func=user_view, methods=['PUT', 'DELETE'])

    return api

Copy
# 関数ベースのルーティング関数
def routers(api):
    # 取得
    # HTTPリクエストにクエリパラメータあり
    # 全件取得 or ageフィルタリング
    @api.route('/functionalBase', methods=['GET'])
    def get_users():
        # GETリクエストを処理
        age = request.args.get('age')
        if age:
            return jsonify(list(filter(lambda user: user['age'] == int(age), users)))
        return jsonify(users)

    # 登録
    # HTTPリクエストからJSONを受け取る
    # JSONデータを新規登録
    @api.route('/functionalBase', methods=['POST'])
    def post_user():
        # POSTリクエストを処理
        data = request.get_json()
        res_users = copy.deepcopy(users)
        res_users.append(data)
        return jsonify(res_users), 201

    # 更新
    # HTTPリクエストにパスパラメータあり
    # パスパラメータをkeyにしてJSONデータで更新
    @api.route('/functionalBase/<user_id>', methods=['PUT'])
    def put_user(user_id):
        # PUTリクエストを処理
        data = request.get_json()
        res_users = copy.deepcopy(users)
        res_users = list(map(lambda user: user.update(data) or user if user['user_id'] == user_id else user, res_users))
        return jsonify(res_users)

    # 削除
    # HTTPリクエストにパスパラメータあり
    # パスパラメータをkeyにして削除
    @api.route('/functionalBase/<user_id>', methods=['DELETE'])
    def delete_user(user_id):
        # DELETEリクエストを処理
        res_users = list(filter(lambda user: user['user_id'] != user_id, users))
        return jsonify(res_users)

Copy
# クラスベースのルーティング
class UserAPI(MethodView):
    # 取得
    # HTTPリクエストにクエリパラメータあり
    # 全件取得 or ageフィルタリング
    def get(self):
        age = request.args.get('age')
        if age:
            return jsonify(list(filter(lambda user: user['age'] == int(age), users)))
        return jsonify(users)

    # 登録
    # HTTPリクエストからJSONを受け取る
    # JSONデータを新規登録
    def post(self):
        data = request.get_json()
        res_users = copy.deepcopy(users)
        res_users.append(data)
        return jsonify(res_users), 201

    # 更新
    # HTTPリクエストにパスパラメータあり
    # パスパラメータをkeyにしてJSONデータで更新
    def put(self, user_id):
        data = request.get_json()
        res_users = copy.deepcopy(users)
        res_users = list(map(lambda user: user.update(data) or user if user['user_id'] == user_id else user, res_users))
        return jsonify(res_users)

    # 削除
    # HTTPリクエストにパスパラメータあり
    # パスパラメータをkeyにして削除
    def delete(self, user_id):
        res_users = list(filter(lambda user: user['user_id'] != user_id, users))
        return jsonify(res_users)

Copy
# 取得
# HTTPリクエストにクエリパラメータあり
# 全件取得 or ageフィルタリング
@api.route('/functionalBase', methods=['GET'])
def get_users():
    # GETリクエストを処理
    age = request.args.get('age')
    if age:
        return jsonify(list(filter(lambda user: user['age'] == int(age), users)))
    return jsonify(users)

Copy
# 登録
# HTTPリクエストからJSONを受け取る
# JSONデータを新規登録
@api.route('/functionalBase', methods=['POST'])
def post_user():
    # POSTリクエストを処理
    data = request.get_json()
    users.append(data)
    return jsonify(users), 201

Copy
# 更新
# HTTPリクエストにパスパラメータあり
# パスパラメータをkeyにしてJSONデータで更新
@api.route('/functionalBase/<user_id>', methods=['PUT'])
def put_user(user_id):
    # PUTリクエストを処理
    data = request.get_json()
    res_users = list(map(lambda user: user.update(data) or user if user['user_id'] == user_id else user, users))
    return jsonify(res_users)

Copy
# 削除
# HTTPリクエストにパスパラメータあり
# パスパラメータをkeyにして削除
@api.route('/functionalBase/<user_id>', methods=['DELETE'])
def delete_user(user_id):
    # DELETEリクエストを処理
    res_users = list(filter(lambda user: user['user_id'] != user_id, users))
    return jsonify(res_users)

Copy
# flaskインスタンス作成
def create_app():
    # 作成
    api = Flask(__name__)

    # 関数ベースのルーティング設定
    routers(api)

    # クラスベースのビューを関数ベースのビューに変換
    user_view = UserAPI.as_view('user_api')

    # エンドポイントを設定
    api.add_url_rule('/classBase', view_func=user_view, methods=['GET',])
    api.add_url_rule('/classBase', view_func=user_view, methods=['POST',])
    api.add_url_rule('/classBase/<string:user_id>', view_func=user_view, methods=['PUT', 'DELETE'])

    # エンドポイント設定をしたflaskインスタンスを返却する
    return api

Copy
$ echo $FLASK_APP
api.wsgi:api
$ echo $FLASK_ENV
development
$ echo $FLASK_DEBUG
true

Copy
$ flask run --host=0.0.0.0
 * Tip: There are .env or .flaskenv files present. Do "pip install python-dotenv" to use them.
 * Serving Flask app 'api.wsgi.py'
 * Debug mode: on
WARNING: This is a development server. Do not use it in a production deployment. Use a production WSGI server instead.
 * Running on all addresses (0.0.0.0)
 * Running on http://127.0.0.1:5000
 * Running on http://172.23.0.2:5000
Press CTRL+C to quit
 * Restarting with stat
 * Tip: There are .env or .flaskenv files present. Do "pip install python-dotenv" to use them.
 * Debugger is active!
 * Debugger PIN: 123-556-262

Copy
# flaskインスタンス生成関数をimport
from api.api import create_app

# flaskインスタンスを生成
api = create_app()

Copy
{
    "version": "2.0.0",
    "tasks": [
        {
            "label": "Flask Run",
            "type": "shell",
            "command": "flask run --host=0.0.0.0",
            "group": {
                "kind": "build",
                "isDefault": true
            },
            "presentation": {
                "reveal": "always"
            },
            "problemMatcher": []
        }
    ]
}

Copy
{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python デバッガー: Flask",
            "type": "debugpy",
            "request": "launch",
            "module": "flask",
            "env": {
                "FLASK_APP": "api.wsgi:api",
                "FLASK_DEBUG": "1"
            },
            "args": [
                "run",
                "--debugger",
                "--reload",
                "--host=0.0.0.0"
            ],
            "jinja": true
        }
    ]
}