PythonのFlaskフレームワークを用いたRest APIのサンプル

pipコマンドを使ってFlaskをインストールします。

 

（コマンド）

> pip install Flask

Flaskがインストール出来たら、早速Rest APIのプログラムを作ります。下記はHello World用のサンプルコードです。

 

（サンプル概要）

ローカルPC上のポート5000番にてFlaskアプリが起動され、URL「http://172.20.10.3:5000/hello/」にGETかPOSTでアクセスした際に「Hello World」を返却するような簡単なAPIのプログラムです。

 

（サンプルPG）

# Flaskクラスのインポート
from flask import Flask
# Flaskクラスのインスタンス生成
app = Flask(__name__)
# route()デコレーターを用いて、どのURLで処理を実行するか？をFlaskに教えています
# methodsはどのHTTPメソッドを許可するか？を設定しています（デフォルトは['GET']）
@app.route('/hello/', methods=['GET', 'POST'])

def helloworld():
    return "Hello World!"

# __name__はPythonにおいて特別な意味を持つ変数です。
# 具体的にはスクリプトの名前を値として保持します。
# この記述により、Flaskがmainモジュールとして実行された時のみ起動する事を保証します。
# （それ以外の、例えば他モジュールから呼ばれた時などは起動しない）
if __name__ == '__main__':
    # Flaskアプリの起動
    # →Webサーバが起動して、所定のURLからアクセス可能になります。
    # →hostはFlaskが起動するサーバを指定しています（今回はローカル端末）
    # →portは起動するポートを指定しています（デフォルト5000）
    app.run(host='0.0.0.0', port=5000)

（図１２１①）

＞目次にもどる

上記プログラムについて、実際にFlaskアプリを起動してみて、想定結果の通りになるか確認してみます。

 

（A）Visual Studio Codeをお使いの場合

→右上の実行ボタンを押下します。

 

（図１３１①）

* Serving Flask app '__init__' (lazy loading)
 * Environment: production
   WARNING: This is a development server. Do not use it in a production deployment.
   Use a production WSGI server instead.
 * Debug mode: off
 * Running on all addresses.
   WARNING: This is a development server. Do not use it in a production deployment.
 * Running on http://172.20.10.3:5000/ (Press CTRL+C to quit)

＞目次にもどる

ブラウザを起動して、先ほどコンソールに表示された起動URLを入力して「Hello World!」が表示されるか？を確認します。

 

確認URL：http://172.20.10.3:5000/hello/

 

（図１４１①）

＞目次にもどる