Docs/Controladores y errores

Páginas de error

Una solicitud que falla debería responder como el resto de su sitio: una página con sus propias palabras para un visitante, el mismo error que JSON para un cliente API. Nexy responde a ambas y un archivo reemplaza cada respuesta.

Esta página es el mapa: qué archivo responde a qué estado y cómo crear el primero. Las páginas de una carpeta obtienen su propia página.

Un fracaso, dos respuestas

a request that fails
      │
      ├── a browser (Accept: text/html)              ──►  an HTML page
      └── an API client (Accept: application/json)   ──►  {"detail": "…"}  with the same status

the HTML page
      ├── the deepest folder of the URL that holds a file   ──►  your file
      └── no folder of the chain holds one                 ──►  the built-in page

Tu primera pagina

Crea src/routes/notfound.nexy y escribe lo que un visitante debe leer:

---metadata = {"title": "Page not found"}---<h1>Page not found</h1><p>The page moved or never existed. <a href="/">Back home</a>.</p>

Guarde y solicite una URL que no sirve:

curl -i -H "Accept: text/html" http://localhost:3000/nowhere# HTTP/1.1 404 Not Found

El archivo en la raíz de rutas responde a todo el proyecto; una copia en una carpeta responde solo a esa carpeta y mantiene el resto como está. Sin ningún archivo, Nexy muestra su página con estilo incorporada.

¿Qué archivo responde?

Deja una página o responde desde el código

redirect, permanentRedirect, notFound, forbidden y unauthorized generan una excepción HTTP, por lo que la misma llamada funciona en una página .nexy, un controlador API, un controlador modular, un guardia y un dependencies.py. Tienen los mismos nombres en el cliente (@nexy/client).

---from nexy import notFound, redirect from src.posts import find slug: prop[str]post = find(slug)if post is None:    notFound()if post.moved_to:    redirect(post.moved_to)---<h1>{{ post.title }}</h1>

Una redirección responde con el encabezado Location y sin página, también a un cliente API. Construya el destino a partir de valores en los que confíe: un redirect(request.query_params["next"]) envía visitantes a donde dice el enlace. Se rechaza un destino con un salto de línea.

Un guardia protege una carpeta completa:

from nexy import unauthorizedfrom nexy.http import Request  def require_login(request: Request) -> None:    if not request.session.get("user"):        unauthorized(scheme="Bearer")  dependencies = [require_login]

HTML o JSON

La misma excepción responde de forma diferente según quién pregunte:

• Un navegador (Accept: text/html) obtiene una página HTML. El detalle tiene formato de escape HTML, por lo que un mensaje creado a partir de la entrada del usuario no puede inyectar marcado.
• Un cliente que solicita JSON y no una página (Accept: application/json) obtiene {"detail": "..."} con el mismo código de estado.

from nexy.http import HTTPException  async def GET(id: int):    if id > 100:        raise HTTPException(status_code=403, detail="Out of range")    return {"id": id}

curl -H "Accept: application/json" http://localhost:3000/api/items/500# {"detail":"Out of range"}

Excepciones no controladas

Una excepción que no se maneja nada se registra una vez, con la excepción, de dónde vino y el código que la rodea, y se responde de acuerdo con el modo.

  x ZeroDivisionError: division by zero  GET /boom  ref fe6a5217    at src/routes/boom.py:2 in GET       1 | def GET():       2 |     return {"a": 1 / 0}

La referencia son ocho caracteres, nuevos para cada fallo. Un visitante puede citarlo y usted encontrará el rastreo buscándolo en el registro. Ni la excepción ni el código llegan al visitante en producción. Un errors.nexy personalizado reemplaza la página únicamente; la línea de registro permanece.

Errores de validación

Un encabezado, parámetro de consulta o campo de cuerpo que falta responde a 422 con el cuerpo JSON de FastAPI, para cada cliente. Ver Validación y errores.

Próximos pasos

• Páginas de error por carpeta: un 404, 403 o 401 propio en una carpeta
• Rutas dinámicas
• Rutas API
• Pruebas

Copiar la página como Markdown Editar en GitHub