API de definición de rutas URL
Flask ofrece tres formas de definir reglas de enrutamiento:@app.route()Decoradores,add_url_rule()Métodos y operación directaurl_map。
Convertidor de variables URL
| Convertidor | Sintaxis | Regla de coincidencia | Tipo de Python |
|---|---|---|---|
| string | <string:name> o <name> | Cualquier texto sin / (predeterminado) | str |
| int | <int:id> | Entero positivo | int |
| float | <float:value> | Número de coma flotante positivo | float |
| path | <path:filepath> | Cualquier texto (incluye /) | str |
| any | <any(a,b,c):item> | Coincide con cualquier valor de la lista | str |
| uuid | <uuid:id> | Formato UUID estándar | str |
Parámetros de add_url_rule
| Parámetro | Tipo | Descripción |
|---|---|---|
| rule | str | Cadena de regla de URL, como "/user/<username>" |
| endpoint | str | Nombre del endpoint; por defecto usa el nombre de la función. url_for lo usa para referenciar la ruta. |
| view_func | callable | Función de vista. Se puede omitir y almacenar más tarde en el diccionario view_functions. |
| defaults | dict | Valor predeterminado para variables de URL. Por ejemplo defaults={"page": 1} |
| subdomain | str | Coincidencia de subdominio. Requiere habilitar subdomain_matching. |
| methods | list | Métodos HTTP permitidos. Por defecto ["GET"] (HEAD y OPTIONS se agregan automáticamente). |
| host | str | Coincidencia de nombre de host. Requiere habilitar host_matching. |
Comportamiento de la barra diagonal final
| Regla | Acceso sin / | Acceso con / |
|---|---|---|
| @app.route("/projects/") | 308 Redirige a /projects/ | Acceso normal |
| @app.route("/about") | Acceso normal | 404 Not Found |
Ruta con valor predeterminado
Variables de URL opcionales mediante el parámetro defaults:
Ejemplo
# Dos URL apuntan a la misma función; /users/ equivale a /users/page/1
@app.route("/users/", defaults={"page": 1})
@app.route("/users/page/<int:page>")
def show_users(page):
return f"Showing page {page}"
# Acceder a /users/ → page=1
# Acceder a /users/page/3 → page=3
@app.route("/users/", defaults={"page": 1})
@app.route("/users/page/<int:page>")
def show_users(page):
return f"Showing page {page}"
# Acceder a /users/ → page=1
# Acceder a /users/page/3 → page=3
Si existen tanto la ruta con valor predeterminado como la ruta con variable, al acceder a la URL con valor predeterminado se redirige con 308 a la forma simplificada.
Convertidor personalizado
Ejemplo
from werkzeug.routing import BaseConverter
# Definir convertidor de tipo personalizado
class ListConverter(BaseConverter):
"""Coincide con listas separadas por comas, como /tags/python,flask"""
def to_python(self, value):
return value.split(",")
def to_url(self, values):
return ",".join(values)
# Registrar en url_map
app.url_map.converters["list"] = ListConverter
# Usar el convertidor personalizado
@app.route("/tags/<list:tags>")
def show_tags(tags):
# tags es una lista de Python: ["python", "flask", "web"]
return f"Tags: {', '.join(tags)}"
# Definir convertidor de tipo personalizado
class ListConverter(BaseConverter):
"""Coincide con listas separadas por comas, como /tags/python,flask"""
def to_python(self, value):
return value.split(",")
def to_url(self, values):
return ",".join(values)
# Registrar en url_map
app.url_map.converters["list"] = ListConverter
# Usar el convertidor personalizado
@app.route("/tags/<list:tags>")
def show_tags(tags):
# tags es una lista de Python: ["python", "flask", "web"]
return f"Tags: {', '.join(tags)}"