ホーム/ FlaskでPython APIを構築する方法

FlaskでPython APIを構築する方法

お気に入りのアプリがどのようにやり取りをしているか疑問に思ったことはありませんか？スマートフォンのボタンをクリックすると、瞬時に情報の世界へとつなげてくれるのはなぜでしょうか？その魔法のような仕組みが、API（アプリケーションプログラミングインターフェース）と呼ばれるものです。まるでメッセンジャーのようにリクエストを受け取り、システムに何を求めているかを伝え、レスポンスを返してくれます。クールですよね？

川原建

2024年12月20日 • 3 min read

今日は、Flaskというとてもシンプルで軽量のPythonウェブフレームワークを使って、独自のAPIを作成する方法を学びましょう。心配しないでください。ステップごとに楽しく簡単に説明します！

ステップ1：始める前に必要なもの

始める前に必要なツールは以下の通りです：

コンピュータにインストールされたPython（まだインストールしていない場合は、Pythonの公式サイトからダウンロードできます）。
Python用のFlaskライブラリ（端末またはコマンドプロンプトを開いて、pip install flaskと入力してインストールできます）。

これで準備完了です！

ステップ2：Flaskとは？

Flaskは、ウェブアプリケーションやAPIを構築するための小さなツールボックスのような存在です。他の大きなフレームワークに比べて軽量ですが、単純なプロジェクトには最適で、学習も簡単です。小さなレストランのキッチンのように、すぐに料理を作ることができます。

ステップ3：シンプルなAPIのセットアップ

リクエストを受け取ってレスポンスを返すAPIを作りましょう。基本構造は以下の通りです：

お気に入りのコードエディタ（VS Code、Sublime、勇気があるならNotepadでもOK）を開きます。新しいファイルを作成し、「app.py」と名前を付けます。

次のコードを入力します：

from flask import Flask, jsonify

app = Flask(__name__)

# シンプルなAPIエンドポイントの作成
@app.route('/hello', methods=['GET'])
def hello_world():
    return jsonify({"message": "Hello, World!"})

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

説明：

Flaskとjsonifyをインポートする: Flaskはウェブアプリを作成するために必要で、jsonifyはデータをJSON形式で返すために使います（コンピュータが好むデータ形式）。
@app.route('/hello', methods=['GET']): FlaskにこのURL（/hello）に対応する準備を指示しています。誰かがこのURLにアクセスすると、APIからメッセージが送られます。
return jsonify({"message": "Hello, World!"}): JSON形式で「Hello, World!」と返します。他のシステムが理解できる形式です。

ステップ4：APIの運用

このAPIを実行するには、端末でapp.pyファイルのあるディレクトリに移動して、以下を入力します：

python app.py

おめでとうございます！初めてのAPIがローカルマシンで動作しました。ブラウザーを開いて「http://127.0.0.1:5000/hello」に訪れると、**{"message": "Hello, World!"}**というメッセージが表示されます。

ステップ5：APIに新しい機能を追加

次に、フルーツのリストを返すAPIを作成してみましょう。以下のコードを使用します：

from flask import Flask, jsonify

app = Flask(__name__)

@app.route('/fruits', methods=['GET'])
def get_fruits():
    fruits = ['apple', 'banana', 'cherry', 'date', 'elderberry']
    return jsonify(fruits)

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

「http://127.0.0.1:5000/fruits」を訪れると、JSON形式でフルーツのリストが表示されます。簡単ですね？

ステップ6：ユーザーリクエストの処理（動的ルート）

さらに高度な操作をしてみましょう！ユーザーの入力に基づいて特定の情報を返すAPIを作成したい場合を考えてみます。動的ルートを使ってこれを実現できます。

次のように実装します：

from flask import Flask, jsonify

app = Flask(__name__)

fruits_info = {
    'apple': '甘い赤い果物です。',
    'banana': '長い黄色の果物です。',
    'cherry': '小さな赤い果物です。'
}

@app.route('/fruits/<fruit_name>', methods=['GET'])
def get_fruit_info(fruit_name):
    info = fruits_info.get(fruit_name, "果物が見つかりません！")
    return jsonify({"fruit": fruit_name, "info": info})

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

「http://127.0.0.1:5000/fruits/apple」にアクセスすると、「甘い赤い果物です。」というメッセージが表示されます。リストにない果物をリクエストすると、「果物が見つかりません！」と表示されます。

ステップ7：まとめと次のステップ

おめでとうございます！Flaskを使って初めてのAPIを作成しました。以下のことを学びました：

Flaskで基本的なAPIを設定する方法。
JSON形式でデータを返す方法。
動的ルートを使ってAPIを柔軟にする方法。

次のステップは、作成したAPIが期待通りに動作することを確認することです。特に実際のシナリオや外部クライアントと連携する際に重要です。ここでAPIテストツールである EchoAPI が活躍します。

HTTPメソッドとAPIテストの詳細については、以下のリンクを参考にしてください。

ASAP (Atlassian) AuthはREST API認証における迅速かつ安全な選択です

EchoAPI は包括的なAPI開発ツールで、APIデバッグ、API設計、ロードテスト、ドキュメント、モックサーバーをカバーしています。登録やサインインなしで素早くテストを開始できます。ノート用の内蔵スクラッチパッドがあり、開発者やチームにとって手頃な価格で、システムを遅くすることなくスムーズに動作する軽量ネイティブクライアントを提供します。これらの特徴がEchoAPIをAPIテストにおける多才でアクセスしやすく、コスト効果の高いツールにしています。

EchoAPIを使用することで、新しく作成したAPIを徹底的にテストし、様々なリクエスト状況をシミュレートし、公開前にアプリケーションが正しく応答することを確認できます。

プログラミング楽しんでくださいね！

無料で始める

ホットトピックス

Postman vs Thunder Client Postmanの代替品 Insomniaの代替品 Brunoで自動テストを行う Thunder Clientの代替品須のVSCode拡張機能