URL ルート定義 API

Flask ではルーティングルールを定義する方法が3つあります:@app.route()デコレータ、add_url_rule()メソッド、直接操作url_map。


URL 変数コンバーター

コンバーター 構文 マッチングルール Python の型
string <string:name> または <name> スラッシュ / を含まない任意のテキスト(デフォルト) str
int <int:id> 正の整数 int
float <float:value> 正の浮動小数点数 float
path <path:filepath> 任意のテキスト(/ を含む) str
any <any(a,b,c):item> リスト内のいずれかの値に一致 str
uuid <uuid:id> 標準 UUID 形式 str

add_url_rule 引数

引数 型 説明
rule str URL ルール文字列。例:「/user/<username>」
endpoint str エンドポイント名。デフォルトでは関数名を使用します。url_for はこれを使用してルートを参照します。
view_func callable ビュー関数。省略可能です。後で view_functions 辞書に格納されます。
defaults dict URL 変数のデフォルト値。例:defaults={"page": 1}
subdomain str サブドメインのマッチング。subdomain_matching を有効にする必要があります。
methods list 許可される HTTP メソッド。デフォルトは ["GET"](HEAD と OPTIONS は自動的に追加されます)。
host str ホスト名のマッチング。host_matching を有効にする必要があります。

末尾スラッシュの挙動

ルール 末尾に / なしでアクセス 末尾に / ありでアクセス
@app.route("/projects/") 308 で /projects/ にリダイレクト 正常にアクセス
@app.route("/about") 正常にアクセス 404 Not Found

デフォルト値ルート

defaults 引数を使用して、オプションの URL 変数を実現します:

例

# 2つのURLが同じ関数を指します。/users/ は /users/page/1 と同じです。
@app.route("/users/", defaults={"page": 1})
@app.route("/users/page/<int:page>")
def show_users(page):
    return f"Showing page {page}"

# /users/ にアクセス → page=1
# /users/page/3 にアクセス → page=3

デフォルト値ルートと変数付きルートの両方が存在する場合、デフォルト値付き URL にアクセスすると、308 で簡略形式にリダイレクトされます。


カスタムコンバーター

例

from werkzeug.routing import BaseConverter

# カスタム型コンバーターを定義する
class ListConverter(BaseConverter):
    """カンマ区切りのリストにマッチします。例: /tags/python,flask"""
    def to_python(self, value):
        return value.split(",")

    def to_url(self, values):
        return ",".join(values)

# url_map に登録する
app.url_map.converters["list"] = ListConverter

# カスタムコンバーターを使用する
@app.route("/tags/<list:tags>")
def show_tags(tags):
    # tags は Python リスト:["python", "flask", "web"]
    return f"Tags: {', '.join(tags)}"
その他の拡張