Flask-RESTful を使って、REST APIを作る【Python Tips】-スケ郎のお話

タイトル_Flask-RESTAfulで REST API作成

Flask + Flask-RESTful を使って、Pythonで REST APIを作ってみます。
前回作成したREST APIを、Flask-RESTfulを使って書き直していきます。

インストール

Flaskと、Flask-RESTfulをインストールします。

$ pip install flask flask_restful

Anaconda環境の場合は次のコマンド

$ conda install flask
$ conda install -c conda-forge flask-restful

サンプルード

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

HTTP メソッド	URL	ペイロード	処理内容
GET	/user?id=<USERID>	なし	ユーザを１件取得
POST	/user/	ユーザ情報(JSON)	ユーザの登録
PUT	/user/	ユーザ情報(JSON)	ユーザの更新
DELETE	/user?id=<USERID>	なし	ユーザの削除


# coding: utf-8
from flask import Flask, abort, request
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

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

class User(Resource):
    def get(self):
        """
        ユーザを１件取得する
        """
        id = request.args.get('id')
        result = [n for n in users if n["id"] == id]

        if len(result) >= 1: 
            # ユーザ情報を返却
            return result[0]
        else:
            # 存在しないユーザIDが指定された
            abort(404)

    def post(self):
        """
        ユーザを登録する
        """
        #ユーザを追加
        users.append(request.json)

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

    def put(self):
        """
        ユーザを更新する
        """
        user = request.json
        lst = [val for val in users if val["id"] == user["id"]]
        
        if len(lst) >= 1: 
            lst[0]["name"] = user["name"]
            lst[0]["age"] = user["age"]
        else:
            #存在しないユーザIDが指定された場合
            abort(404)

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

    def delete(self):
        """
        ユーザを削除する
        """
        id = request.args.get('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)

api.add_resource(User, '/user')

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