【Flask】Flask-RESTfulでREST APIを実装する

Copy
pip install flask flask_restful

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 #デバッグモードの指定

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
flask_restful==0.3.10

Copy
from flask import Flask, request
from flask_restful import Api, Resource
import copy

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

# flask_restfulのApiインスタンス作成と関連づけ
flask_api = Api(api)

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

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

    # 登録
    # HTTPリクエストからJSONを受け取る
    # JSONデータを新規登録
    def post(self):
        data = request.get_json()
        res_users = copy.deepcopy(users)
        res_users.append(data)
        return 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 res_users

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

# エンドポイントとリソースクラスをマッピングする
flask_api.add_resource(UserAPI, '/flaskRestful', endpoint='users')
flask_api.add_resource(UserAPI, '/flaskRestful/<string:user_id>', endpoint='user')

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

# flask_restfulのApiインスタンス作成と関連づけ
flask_api = Api(api)

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

    # 登録
    # HTTPリクエストからJSONを受け取る
    # JSONデータを新規登録
    def post(self):
        data = request.get_json()
        res_users = copy.deepcopy(users)
        res_users.append(data)
        return 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 res_users

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

Copy
# エンドポイントとリソースクラスをマッピングする
flask_api.add_resource(UserAPI, '/flaskRestful', endpoint='users')
flask_api.add_resource(UserAPI, '/flaskRestful/<string:user_id>', endpoint='user')

Copy
flask_api.add_resource(UserAPI, '/flaskRestful','/flaskRestful/<string:user_id>')

Copy
# 取得
    # 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)