Flaskで REST API開発する! 直ぐに実行できるサンプルコードで解説 【Python Tips】

2018年11月25日日曜日

Flask Python RestAPI

t f B! P L

Flaskで REST API開発する! 直ぐに実行できるサンプルコードで解説 【Python Tips】

enter image description here

Pythonの軽量Webフレームワークである、FlaskでREST APIを作るまでの流れを、サンプルコードで紹介します。

Pythonの2大Webフレームワークとして、FlaskとDjangoがあります。
Googleドレンドで見ると、始めはDjangoが大きくリードしていましたが、2018年11月現在、Flaskが大きく追い上げています。
IoTブームなどで、最近自分の周りでは、APIだけを開発する案件がメチャクチャ多いです。
そんな時に、FlaskはサクッとAPI開発が出来るので、よくお世話になってます。

enter image description here

ちなみに日本ではまだDjangoの方が人気っぽいです

enter image description here

インストール

Pythonのインストール

Python3がインストールされていない場合は、こちらを参考に、インストールを行って下さい。

Flaskのインストール

以下のコマンドでFlaskをインストールします。

pip3 install flask

サンプルード

ユーザ情報を、取得/登録/更新/削除する、REST APIのサンプルです。
HTTPメソッドによって、処理モードを振り分けています。

HTTP メソッド URL ペイロード 処理内容
GET /user/<USERID> なし ユーザを1件取得
POST /user/ ユーザ情報(Form) ユーザの登録
PUT /user/ ユーザ情報(Form) ユーザの更新
DELETE /user/<USERID> なし ユーザの削除
# coding: utf-8
from flask import Flask, jsonify, abort, request

app = Flask(__name__)

# テストデータ
users = [
    { "id": "U001", "name": "ユーザ太郎", "age": 27 },
    { "id": "U002", "name": "ユーザ二郎", "age": 20 },
    { "id": "U003", "name": "ユーザ三郎", "age": 10 }
]

#######################################################################
@app.route('/user/<string:id>', methods=['GET'])
def findUser(id):
    """
    ユーザを1件取得する
    """
    result = [n for n in users if n["id"] == id]

    if len(result) >= 1: 
        # ユーザ情報を返却
        return jsonify(result)
    else:
        # 存在しないユーザIDが指定された
        abort(404)
        
#######################################################################
@app.route('/user/', methods=['POST'])
def createUser():
    """
    ユーザを登録する
    """
    #ユーザを追加
    data = {
        "id": request.form["id"],
        "name": request.form["name"],
        "age": int(request.form["age"])
    }
    users.append(data)

    #正常に登録できたので、HTTP status=204(NO CONTENT)を返す
    return '', 204

#######################################################################
@app.route('/user/', methods=['PUT'])
def updateUser():
    """
    ユーザを更新する
    """
    id = request.form["id"]
    lst = [val for val in users if val["id"] == id]
    
    if len(lst) >= 1: 
        lst[0]["name"] = request.form["name"]
        lst[0]["age"] = int(request.form["age"])
    else:
        #存在しないユーザIDが指定された場合
        abort(404)

    #正常に更新できたので、HTTP status=204(NO CONTENT)を返す
    return '', 204

#######################################################################
@app.route('/user/<string:id>', methods=['DELETE'])
def deleteUser(id):
    """
    ユーザを削除する
    """
    lst = [i for i, val in enumerate(users) if val["id"] == id]
    for index in lst:
        del users[index]

    if len(lst) >= 1: 
        #ユーザの削除を行った場合、HTTP status=204(NO CONTENT)を返す
        return '', 204
    else:
        #存在しないユーザIDが指定された場合
        abort(404)

if __name__ == "__main__":
    app.run(debug=True)

実行

アプリを作成したディレクトリに移動して、以下のコマンドを入力すると、開発用サーバが起動します。

$ flask run --debugger --reload

 * Environment: production
   WARNING: Do not use the development server in a production environment.
   Use a production WSGI server instead.
 * Debug mode: off
 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
 * Restarting with stat
 * Debugger is active!
 * Debugger PIN: 131-136-572

ブラウザを立ち上げて、「http://127.0.0.1:5000/user/U001」を入力してください。
ユーザのJSONが表示されれば、起動成功です。

おわりに

簡単なコードでREST APIがつくれました。
Flaskいいですね〜!!

関連記事

MacにPython3をインストールする! (サクッとインストールしたい人向け)

Mac環境に、Python3を簡単にインストールする方法を紹介しています。

Python3入門! 基礎をおさらい (変数/演算子/条件分岐/繰り返し)

1つの記事に、基本文法をまとめて書いているので、時間が空いて忘れてしまった場合でも、一気に復習出来るようになっています。よければ見てください。

Flaskでソースの変更を検知して、Webアプリを自動リロードする[Python Tips]

Flaskの開発で、ソースを更新したら、自動的にWebアプリをリロードする方法です。

Flask-RESTful を使って、REST APIを作る【Python Tips】

Flaskと、Flask-RESTfulを使って、REST APIを作ります。
Flask-RESTfulを使うと、オブジェクト思考な感じで、REST APIが作れます。

Pythonで小数点の四捨五入/切り捨て/切り上げを行う

Pythonのdecimalモジュールを使って、小数点の丸めを行う方法です。

スポンサーリンク

QooQ