Docs/Python API y errores

Excepciones y errores

Una solicitud puede fallar en cuatro lugares y Nexy responde a cada uno de manera diferente. Esta página es el índice: busque el estado que ve, luego la línea que lo produjo, luego el archivo que decide el cuerpo.

La versión corta

Un cliente API es una solicitud cuyo encabezado Accept solicita JSON y no una página:

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

De donde viene un fracaso

Browser ──► Middleware ──► Router ──► Page or handler
                 │            │             │
                 │            │             ├─ return ───────────► 200
                 │            │             ├─ HTTPException ────► its status
                 │            │             └─ other exception ───► 500
                 │            └─ no match ────────────────────────► 404
                 └─ raises ──────────────────────────────────────► 500

Salir desde cualquier lugar

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, un dependencies.py y una acción.

from nexy import notFound, redirect from src.posts import find  async def GET(slug: str):    post = find(slug)    if post is None:        notFound("No such post")    if post.moved_to:        redirect(post.moved_to)    return post

from nexy import notFound, redirectfrom nexy.decorators import Controller from src.posts import find  @Controller("/posts/{slug}")class PostsBySlugController:    async def get(self, slug: str):        post = find(slug)        if post is None:            notFound("No such post")        if post.moved_to:            redirect(post.moved_to)        return post

Construya el destino a partir de valores en los que confíe. redirect(request.query_params["next"]) envía visitantes a donde dice el enlace; es una redirección abierta. Se rechaza un destino que contenga un salto de línea.

Validación: 422 o 404

Los parámetros del controlador son validados por FastAPI contra sus anotaciones.

from nexy.http import Header  async def GET(q: str, limit: int = 10, x_token: str = Header(...)):    return {"q": q, "limit": limit}

from nexy.decorators import Controllerfrom nexy.http import Header  @Controller("/api/search")class SearchApiController:    async def get(self, q: str, limit: int = 10, x_token: str = Header(...)):        return {"q": q, "limit": limit}

El cuerpo de 422 tiene la forma estándar de FastAPI, por lo que los clientes y los SDK generados siguen funcionando:

{"detail": [{"loc": ["query", "q"], "msg": "Field required", "type": "missing"}]}

Para un formulario o una acción, el cliente recibe un ActionError con status y detail; un 422 también llena error.fields con un mensaje por campo. Ver Acciones.

Páginas de error personalizadas

<h1>Page not found</h1><p>The link may be old. <a href="/">Start from the home page</a>.</p>

<h1>Something went wrong</h1><p>Try again in a moment.</p>

Excepciones no controladas

Una excepción en la que no se detecta nada se registra una vez, con su referencia, de dónde proviene y el código que la rodea. El estado es 500 y el cuerpo depende del medio ambiente.

  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.

Acciones y formas

Una acción es un punto final POST con una ruta generada. Sus fallos siguen las mismas reglas:

Un formulario sin JavaScript publicaciones en la ruta de acción; un éxito responde 303 de regreso a la página, un error muestra la página de error. Consulte Acciones.

Una lista de verificación cuando una página responde algo incorrecto

1. Mire el estado, no la página. Un notfound.nexy personalizado todavía responde 404.
2. Lea la terminal. Una página que no se puede importar no está registrada, por lo que su URL responde 404 mientras el archivo exista. El error de importación está en el registro.
3. Verifique la extensión. Con useCSR = True, .nexy las páginas pertenecen al modo servidor; una página en el modo incorrecto no es una ruta.
4. Verifique la profundidad. Un notfound.nexy o errors.nexy solo funciona cuando existe la copia raíz.
5. Solicite JSON con Accept: application/json para ver la forma que recibe su cliente API.
6. Cite la referencia de un 500 cuando abra un número o busque en el registro.

Próximos pasos

• Páginas de error: el comportamiento de la página completa, con ejemplos
• Validación y errores: Controladores de API
• Solución de problemas: los errores que la gente realmente encuentra
• Pruebas: afirmar un estado y un cuerpo

Copiar la página como Markdown Editar en GitHub