スキップしてメイン コンテンツに移動

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モジュールを使って、小数点の丸めを行う方法です。

コメント

このブログの人気の投稿

axiosの使い方まとめ (GET/POST/例外処理)

axiosの使い方まとめ (GET/POST/例外処理)最近何かとよく使うJavaScriptでAJAX通信を行うaxiosについて、簡単に使い方をまとめました。GETリクエストをaxiosで送るまずはGETリクエストをaxiosで送る方法です。const res =await axios.get('/users') console.log(res.data)分割代入の記法を使うと、以下のようにも書けますconst{data}=await axios.get('/users') console.log(data)クエリパラメータ (URLパラメータ)を指定クエリパラメータを指定する方法は2つあります。1つ目は、axios.getに指定するURLに直接記述する方法です。axios.get('/user?id=123')2つめは、axios.getの第2引数に、オプション指定する方法です。axios.get('/user',{ params:{ id:123}})POSTリクエストをaxiosで送る次はPOSTリクエストをaxiosで送る方法です。JSON形式でPOSTするJSON形式でPOSTする場合は、axios.postの第2引数に、送信するデータをJavaScriptオブジェクトで指定します。const res =await axios.post('/user',{ id:123, name:'Yamada Tarou'})application/x-www-form-urlencoded形式でPOSTするapplication/x-www-form-urlencoded形式でPOSTする場合は、URLSearchParamsを使います。var params =newURLSearchParams() params.append('id',123) params.append('name','Yamada Tarou')const res =await axios.post('/user', params)スポンサーリンク axios でファイルをアップロードする画像などのファイルを、…

[VB, C#] Windows 8, Window 10 で ImeModeが制御できない問題を解決する

[VB, C#] Windows 8, Window 10 で ImeModeが制御できない問題を解決するタイトルの通りですが、Windows 8 以降では Windows Form アプリケーションで、コントロールの ImeMode に Katakana や KatakanaHalf を設定しても、カタカナになってくれません。なぜ ImeMode が効かないのか?Windows 8 以降、IME Mode の切り替えは、ユーザー単位で切り替わるようになった為、アプリから IME Mode 制御が出来ないようになりました。
(IME をON にした場合、常に ひらがな モードになます)※ Windows 7までは、IME Modeの切り替えはアプリ単位で行われていた為、問題なくアプリから IME制御が行えました。スポンサーリンク 対処方法Windows 8 以降、IMEの制御は、InputScope クラスの利用が推奨されています。
しかし、InputScope クラスは、WPF、Windows ストアアプリでしか使えない為、Windows Formアプリでは使用できません。
(Windows Form はもう使うな!という事でしょうか (涙) )結論としては、コントールパネルの設定で、IMEの制御をユーザ単位から アプリ単位に変更する事ができます。
これで、Windows Formアプリでも 従来通りIMEの制御を行う事が出来ます。おわりにこの方法だと、アプリをインストールする端末すべてに設定が必要となり、とっても面倒です。。。
しかし、今の所これしか方法がない状態です。
これからは Windows Formではなく、WPFや Windows ストアアプリで作れという事ですかね (^^;)

MailKitの使い方! エンコーディング指定や添付ファイをメールで送信する方法[C#/VB Tips]

MailKitの使い方! エンコーディング指定や添付ファイをメールで送信する方法[C#/VB Tips]MailKitを使ってメールを送るサンプルコードです。(C#)UTF8/iso-2022-jpのエンコーディング指定、GMail/YahooのSMTPサーバで送るなど、4つのサンプルコードでMailKitの使い方を紹介します。MailKitって何?2017年に.NET標準のSystem.Net.Mail.SmtpClientが廃止予定となり、Microsoftより今後はオープンソースライブラリである、MailKitに置き換えるとアナウンスがありました。既にSmtpClientは非推奨になっており、今後は廃止されていきます。現在、SmtpClientを使用したソースコードには、Visual StudioからMailKitを使うよう警告が出るようになっています。さっそく、MailKitを使ってメールを送信するサンプルコードを作っていきます。UTF8でメールを送信文字エンコーディングを、UTF8でメールを送信するサンプルコードです。
MailKitは、デフォルトの文字エンコーディングがUTF8なっている為、シンプルなコードでメールを送信する事ができます。var host ="<smtp server name>"; var port =25;// or 587using(var smtp =new MailKit.Net.Smtp.SmtpClient()){//SMTPサーバに接続する smtp.Connect(host, port, MailKit.Security.SecureSocketOptions.Auto);//認証が必要な場合は、以下のコメントを解除//smtp.Authenticate("<id>", "<password>");//送信するメールを作成する var mail =new MimeKit.MimeMessage(); var builder =new MimeKit.BodyBuilder(); mail.From.Add(new MimeKit.MailboxAddress("",&quo…