- Flaskのインストール: まず、Flaskをインストールする必要があります。以下のコマンドを使用して、Flaskをインストールしてください。
pip install flask
- Flaskアプリの作成: 次に、Flaskアプリケーションを作成します。以下のような基本的な構造のファイルを作成します。
from flask import Flask
app = Flask(__name__)
@app.route('/')
def hello():
return "Hello, World!"
if __name__ == '__main__':
app.run()
- APIルートの追加:
APIのエンドポイントを追加するには、
@app.route
デコレータを使用します。以下の例では、/api/data
エンドポイントにGETリクエストが送信された場合に、サンプルのデータを返します。
@app.route('/api/data', methods=['GET'])
def get_data():
data = {
'name': 'John Doe',
'age': 30,
'city': 'Tokyo'
}
return jsonify(data)
- パラメータの処理:
APIでパラメータを処理する場合、URLの一部やクエリパラメータとして受け取ることができます。以下の例では、
/api/user/<username>
エンドポイントにGETリクエストが送信された場合に、指定されたユーザー名を返します。
@app.route('/api/user/<username>', methods=['GET'])
def get_user(username):
return f"Hello, {username}!"
これらの例は、Flask APIの基本的な機能と使い方を示しています。さらに高度な機能やデータベースの統合など、さまざまな方法でFlaskを使用することができます。詳細なドキュメントやチュートリアルは、Flaskの公式ウェブサイトで入手できます。
以上が、Flask APIの設定方法とコード例の紹介です。この記事を参考に、自分のAPIを作成してみてください。