Doku/Python API und Fehler

Ausnahmen und Fehler

Eine Anfrage kann an vier Stellen fehlschlagen, und Nexy antwortet jeweils anders. Diese Seite ist der Index: Suchen Sie den Status, den Sie sehen, dann die Zeile, die ihn erzeugt hat, und dann die Datei, die den Hauptteil bestimmt.

Die Kurzversion

Ein API-Client ist eine Anfrage, deren Header Accept nach JSON und nicht nach einer Seite fragt:

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

Woher ein Fehler kommt

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

Von überall losfahren

redirect, permanentRedirect, notFound, forbidden und unauthorized lösen eine HTTP-Ausnahme aus, sodass derselbe Aufruf auf einer .nexy-Seite, einem API-Handler, einem modularen Controller, einem Guard, einem dependencies.py und einer Aktion funktioniert.

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

Bauen Sie das Ziel auf der Grundlage von Werten auf, denen Sie vertrauen. redirect(request.query_params["next"]) schickt Besucher dorthin, wo der Link steht; Es handelt sich um eine offene Weiterleitung. Ein Ziel, das einen Zeilenumbruch enthält, wird abgelehnt.

Validierung: 422 oder 404

Handler-Parameter werden von FastAPI anhand ihrer Anmerkungen validiert.

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}

Der 422-Körper hat die Standardform von FastAPI, sodass Clients und generierte SDKs weiterhin funktionieren:

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

Für ein Formular oder eine Aktion erhält der Client ein ActionError mit status und detail; a 422 füllt auch error.fields mit einer Nachricht pro Feld. Siehe Aktionen.

Benutzerdefinierte Fehlerseiten

<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>

Nicht behandelte Ausnahmen

Eine Ausnahme, bei der nichts abgefangen wurde, wird einmalig protokolliert, mit ihrer Referenz, woher sie kam und dem Code um sie herum. Der Status ist 500 und der Körper ist von der Umgebung abhängig.

  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}

Die Referenz besteht aus acht Zeichen und ist für jeden Fehler neu. Ein Besucher kann es zitieren, und Sie finden den Traceback, indem Sie das Protokoll danach durchsuchen. Weder die Ausnahme noch der Code erreichen den Besucher in der Produktion.

Aktionen und Formen

Eine Aktion ist ein POST Endpunkt mit einem generierten Pfad. Seine Fehler folgen den gleichen Regeln:

Ein Formular ohne JavaScript Beiträge zum Aktionspfad; Bei Erfolg wird 303 auf die Seite zurückgeleitet, bei Fehler wird die Fehlerseite angezeigt. Siehe Aktionen.

Eine Checkliste, wenn eine Seite die falsche Antwort gibt

1. Sehen Sie sich den Status an, nicht die Seite. Ein Brauch notfound.nexy antwortet immer noch 404.
2. Lesen Sie das Terminal. Eine Seite, deren Import fehlschlägt, ist nicht registriert, daher antwortet ihre URL 404, solange die Datei vorhanden ist. Der Importfehler steht im Protokoll.
3. Überprüfen Sie die Erweiterung. Mit useCSR = True gehören .nexy Seiten zum Servermodus; Eine Seite im falschen Modus ist keine Route.
4. Überprüfen Sie die Tiefe. Ein notfound.nexy oder errors.nexy funktioniert nur, wenn die Root-Kopie vorhanden ist.
5. Fragen Sie nach JSON mit Accept: application/json, um die Form zu sehen, die Ihr API-Client erhält.
6. Geben Sie die Referenz eines 500 an, wenn Sie ein Problem öffnen oder das Protokoll durchsuchen.

Nächste Schritte

• Fehlerseiten: das vollständige Seitenverhalten mit Beispielen
• Validierung und Fehler: API-Handler
• Fehlerbehebung: Die Fehler, auf die die Leute tatsächlich stoßen
• Testen: Stellen Sie einen Status und einen Körper sicher

Seite als Markdown kopieren Auf GitHub bearbeiten